开发者控制台

步骤1: 创建您的目录文件

步骤1: 创建您的目录文件

在这一步,您需要为应用程序的媒体内容(电影、电视节目和花絮)创建包含元数据(标题、长度、发行年份等)在内的目录文件。此目录文件必须遵循目录数据格式 (CDF) 架构,这就要求您采用特定的XML结构来描述媒体内容。

此视频将指导您完成这个过程。有关更多信息,请继续查看以下页面。

创建您的目录文件

要创建文件,请使用自动化流程开发程序脚本,它会从您的数据库中提取信息,并将数据转换为兼容CDF的目录文件。

要创建文件,您一般需要先熟悉XML及其概念,因为这些内容与目录XSL架构挂钩,请参阅CDF概览。然后下载CDF架构XSD文件,深入了解其逻辑和规则。您也可以从元素网页中显示的代码示例入手。创建文件时,请查阅CDF参考文档

通用目录文件结构

本节概述了CDF架构及其元素的结构。用户应该能很好地掌握XML。

目录文件的顶级大纲可以表示为:

<Catalog>
    <Partner> ... </Partner>
        <Works>
        ...
        </Works>
</Catalog>

Catalog必填)是所有目录文件的根元素。

Partner必填)验证您的身份为内容提供方。

Works必填)包含文件的大部分内容:资料库中的所有电影和电视节目、有关每个条目的尽可能多的信息,以及允许用户查看这些内容的服务。

Works元素可以添加任意数量的子元素,分别表示一部作品,如电影或电视节目。如果Works元素中不含子元素,则亚马逊会认为您的所有内容均不再可用,进而从索引中删除这些内容。

以下是最常见的作品类型元素:

元素 描述
Movie 可以表示长篇电影,也可以表示短篇电影。
TvEpisode TvShow中的某一集,通常还和TvSeason有关。
TvSeason TvSeason是指TvShow中的一季,是一种基本作品类型。
TvShow 由季和剧集组成的电视连续剧。
Extra 独立作品的片段,或通常与(目录上或目录外的)其他作品有关。

Movie属于独立元素。TVShow、TVSeason和TVEpisode都是独立元素,通过ID紧密关联。Extra(花絮)可以是独立元素,也可以与其他作品有关。有关详细信息,请参阅关联节目、季和剧集

所有作品的共同元素

上述所有作品类型均以核心共同元素为基础。针对每种情况,仅扩展了1 - 5个特定类型的元素。只需要一小部分共同元素。

Work元素的大纲可以表示为:

<_WorkType_>(如<Movie><TvSeason><ID>
        <Title>
            <Offers>
</_WorkType_>

ID(必填)是您为作品选择的标识符。在目录中,每部作品都有唯一ID,一经提交就不再更改。ID元素还能用于相关作品元素,如指定电视剧集为电视节目和电视季的内容。

Title(必填)当然是指作品标题。您可以提供多种语言版本的标题。

Offers(必填)中包含客户可免费观看或订阅后观看作品的方法。服务可能会受到时间或区域的限制。Offers元素必须添加至少一项服务,必要时可以添加任意数量的服务。共有四种服务类型:

优惠类型 描述
FreeOffer 您可以随时免费查看作品,也可以只在给定窗口免费观看。
SubscriptionOffer 订阅了提供方服务的用户可以观看此作品。

包含可选元素在内的服务概述可以表示如下:

<_OfferType_>(如<FreeOffer><SubscriptionOffer><Regions>
        <WindowStart>
            <WindowEnd>
                <LaunchDetails>
                    <Price>(仅限租赁或购买)
                        <Duration>(仅限租赁)
</_OfferType_>

Regions(必填)指定服务生效的国家/地区。Regions是必填项,并且必须包含至少一个Territories元素。

在指定服务生效时间时,可以结合使用WindowStartWindowEnd(均为选填),也可以单独使用。用户只能在WindowStartWindowsEnd期间找到服务。

您可以使用LaunchDetails(选填)指定此服务下的视觉质量、音频语言和字幕选项。还可以用它定义特殊ID,使用这些选项的预定配置直接发行作品。

给定作品的可用情况如有更改,请务必提交包含新服务信息在内的最新目录文件。

电影、花絮或电视节目的详细信息页面会显示此商品的所有可用服务和提供方。亚马逊按以下顺序显示查看选项(可能会更改):

  • 免费优惠
  • 订阅内容
  • 收费内容(购买或租赁)

所有作品的常见可选元素

截止目前,我们已经讨论了常见的必填元素和一些选填元素。只需使用这些元素,您就能掌握构造有效目录文件的知识。

这些元素的数量仅占可用总元素数量的三分之一。其余所有常见元素均为选填元素,可提供有关作品的更多信息。

如题材、认证、演职人员、剧情描述、工作室、图像和客户评分等元素。有关完整列表,请参阅目录数据格式 (CDF) 架构

关于字符串的注意事项

注入作品标题和描述等部分字符串数据属于CDF架构,其定义为自定义LocalizedString类型。您可以使用本地化字符串提供不同语言版本的相同内容,以适配用户设备的语言设置。这些字符串具有必填attribute属性localexsd:language的标准类型)。示例如下:

<Title locale="en-US">Edison Kinetoscopic Record of a Sneeze</Title>

本地化字符串还有一项选填attribute属性pronunciationxsd:string的标准类型)。这项attribute属性专为使用汉字指定字符串文本的日语目录条目提供。日语基于发音而不是字符进行预期排序(无法根据汉字确定)。pronuciationattribute属性通常使用平假名,可提供此信息。

作品类型特定元素

除共同元素外,每种作品类型都有专属的一到五个特定元素。这些元素一般有两种用途: (1) 用于指定原定发行日期或播出日期,以及 (2) 用于结合作品,比如将电视剧集与电视节目结合。

发行日期虽然是选填元素,但建议填写,可通过ReleaseDate(适用于电影或电视节目)或OriginalAirDate(适用于电视剧集)进行指定。

关联节目、季和剧集的元素是必填项,将在下一节进行深入讨论。

有关特定类型元素的详细信息,请参阅目录数据格式 (CDF) 架构

关联节目、季和剧集

电视剧集会在特定电视节目的某一季中播出。花絮可提供有关电影的预告或幕后信息。

CDF为您提供建立此类连接的元素。使用这些元素后,Fire TV用户可浏览按季排序的电视节目,这一季的每一集都会按顺序显示。

一般可以通过ID或标题将两部作品关联起来。此ID必须匹配目录中另一部作品的ID。如果目录中找不到此作品,则可以改用标题。此标题无需与目录中的任何内容匹配,仅用于作品分组。 

下表显示了各种作品类型中包含的这些元素:

作品类型 链接元素
TvEpisode ShowIDShowTitle
SeasonIDSeasonInShow
注意:​ TvEpisode也有SeasonTitle元素,但不能用于分组。
TvSeason ShowIDShowTitle
TvShow
Extra RelatesToIDRelatesToExternalID
Movie

TvEpisode不是使用标题,而是使用编号指定目录外的季。Extra则使用IMDb等指向外部ID模式的链接。虽然您可以选择要用的编号,但每个元素链接对的编号都是TvEpisodeTvSeason中的必填项。此链接值是Extra选填项,可以独立运行。

下图显示了在使用ID时电视节目的各种元素和值如何进行匹配。

图中显示了电视节目、季和剧集的ID之间的关系。

例如,TvShow的ID是TV-123456,则TvEpisodeTvSeasonShowID值也等于TV-123456

封面图要求 (ImageUrl)

ImageUrl元素是所有作品都有的一种选填元素,负责提供表示作品的图像URL,有时也叫“封面图”。 如果您没有添加ImageUrl,则亚马逊会尝试使用其他来源的可匹配资源库,如IMDb,也可能使用通用的占位符图像。

图像要求

要求 图像 描述
类型 JPG(首选)或PNG 不得使用其他图像类型
宽高比 16 X 9 信息提要中的图像应遵循16x9的宽高比。
尺寸 高度大于240像素(首选480像素) 引入报告会对高度小于480像素的图像生成警告,但可以接受高度在240像素和480像素之间的图像,不计入无效图像的总数。不得使用高度小于240像素的图像。为保证最优质量,亚马逊首选可按需缩放的更大图像(图像尺寸不会太大)。

注意:​ 如果亚马逊因宽高比要求需要裁剪图像,则无论原始尺寸如何,裁剪后的版本仍必须满足此高度要求。

亚马逊建议您提交至少满足此规格的图像。请注意,这是指封面图,而不是指作品本身。

CDF常见问题解答

问: 我要如何创建目录文件?
答: 您可以采用编程方式,将元数据导出到符合CDF格式的XML文件。
问: 我的电视节目有很多季和剧集。我应该使用哪些内容类型进行分类?
答: 使用TvShowTVSeasonTvEpisode
问: 我的电视节目有连续剧集,但没有序列号。这些剧集不是按照序列号排序的,而是按照其播出日期排序的。我应该使用哪种内容类型?
答: 使用TvShow类型。
问: 新闻类内容的剧集没有季,但有播出日期。我应该使用哪种内容类型?
答: 使用TvShow类型。
问: 我的节目有季,但没有适用的实际值。我该怎么做?
答: 您必须为具有季的节目添加季值,以免破坏用户体验。要获取季信息,请尝试查看IMDb等权威目录。亚马逊一般建议您省略缺少季值的相关内容,而非试图让节目适应另一种内容类型。此操作有助于让用户留下良好的观影体验。
问: 要记住的规则似乎太多了。要是不记住每个细微差别,我怎么知道要做什么?
答: 一般只要满足客户期望即可。例如,您的电视连续剧是每晚播出的脱口秀节目,则客户可能不会认为这种连续剧有很多季。在这种情况下,播出日期更为重要。但如果您的热播剧吸引了大量用户观看,则季和剧集的编号对观众来说可能更重要。
问: 我已创建目录文件。接下来应该怎么做? 我可以直接将其上传到AWS S3吗?
答: 亚马逊强烈建议您先验证目录文件中的XML,然后再将其上传到AWS S3。如果您的CDF包含任何格式错误或无效的XML,则亚马逊会拒绝此文件。有关详细信息,请参阅步骤2: 有关更多详细信息,请验证您的目录文件

后续步骤

创建目录文件后,继续执行步骤2: 验证您的目录文件


Last updated: 2023年12月18日