开发者控制台

目录数据格式 (CDF) 概述

目录数据格式 (CDF) 概述

本主题提供了目录数据格式 (CDF) 架构中可用的元素字典,用于构建要上传到亚马逊Fire TV的媒体内容目录。

CDF架构

目录数据格式 (CDF) 架构可定义描述媒体所需的元素,以便亚马逊为您集成目录。catalog.xsd文件中定义了此架构。此架构包含150多个适用于不同媒体类型的元素,如电影、电视节目、广播等。您可以通过以下方式下载catalog.xsd文件:

您可以通过两种方式查看目录架构文档:

以下视频会指导您使用CDF创建目录:

经过元素筛选的网页

您可以查看开发者门户中的网页所列的架构元素。虽然可以查看平面列表中的所有元素,但选择常见的父元素(如Movie)并查看其适用的图表和代码示例,这种做法更符合实际。

具有筛选元素的网页
具有筛选元素的网页

单击图表或代码示例中的元素时,相关描述会滚动到图表或代码下方的焦点。

具有图表和代码页的元素如下所示:

直接查看XSD文件

您也可以直接在XML编辑器(如OxygenXML编辑器)中查看catalog.xsd文件,获取更多增强型导航控件。

还可以直接读取XSD文件,学习架构逻辑。如果不熟悉XSD文件,请参阅XML架构第0部分: 入门指南第二版进行介绍。有关XSD架构的更多正式参考文档,请参阅XML架构第1部分: 结构第二版XML架构第2部分: 数据类型第2版

以下是关于XSD文件阅读的一些技巧:

XSD属性 意义所在
xsd:element 标识一个元素
minOccurs="0" 此为选填元素
maxOccurs="unbounded" 此元素可无限次重复。
xsd:simpleType 此元素不含任何子元素或attribute属性。有关更多详细信息,请参阅simpleType
xsd:complexType 此元素可以有子元素或attribute属性。复杂类型的内容模型描述会指定子元素是否必须按顺序排列,以及是否有二者择一的要求或其他逻辑。有关更多详细信息,请参阅complexType
xsd:choice 表示您必须从子元素中选出想要添加的元素。逻辑可以是一种元素或其他属性,但不能两者兼有。例如,Credits只能添加CastMemberCrewMember的子元素,但不能同时添加两者。
xsd:sequence 表示子元素必须遵循指定序列。例如,CustomerRating要求ScoreMaxValueCount这三个子元素按顺序出现,其中Count为选填元素。
结合xsd:sequencexsd:choice 有些元素会结合使用sequence(序列)和choice(选择)。在这种情况下,内容模型描述即可说明使用情况。
xsd:annotation 表示元素文档。请注意,目录XSD文件的每个元素虽然都有一些注释元素,但描述很简短,不能作为官方文档。网页上的文档可以作为说明元素的官方文档。XSD文件的价值在于标识内容模型逻辑和所需用法,而非理解每个元素的含义。
xsd:enumeration 允许使用枚举值作为simpleType的值。通过枚举,将选项限制为预定义字符串列表。
xsd:extension base= 基于另一个元素建立元素逻辑。此元素基于另一个元素进行扩展。
xsd:attribute 此元素允许attribute属性。有关XML中的attribute属性描述,请参阅2.2 复杂类型定义、元素与attribute属性说明(仅提供英文版)。

XML数据类型

诸如字符串、布尔值和整数等特定数据类型都会直接内置到XML架构中。下表定义了您将在目录中看到的常见数据类型。您可以在教程链接或w3.org官方网站上阅读更多详细信息。(教程链接提供了更易阅读和理解的数据类型描述,而w3.org链接提供了官方架构参考。)

XML数据类型 描述 教程链接 W3C链接
boolean true值或false xsd:boolean w3.org
decimal 带小数的数字,如5.2 xsd:decimal w3.org
date 日期值的格式为2019-02-19 xsd:boolean w3.org
dateTime 此值采用YYYY-MM-DDThh:mm:ss的格式,其中YYYY-MM-DD是指年份、月份和日期,而hh:mm:ss是指小时、分钟和秒。示例: 2003-08-08T17:18:37。字母T将两部分隔开。从年份到秒数的整个值都是必填值。如果时间值未知,只需使用00:00:00。您还可以在值末尾添加与UTC时间的时差,用于解释特定时区。 xsd:dateTime w3.org
duration 持续时间的书写格式为以P开头,依次紧跟年、月、日、时、分、秒。例如,P2Y6M5DT12H35M30S xsd:duration w3.org
int 整数(一个整数),如5 xsd:int w3.org
language 语言标识符,如en xsd:language w3.org
NonEmptyToken xsd:token相同,但不得为空。 xsd:token w3.org
字符串 字母数字的字母和数字 xsd:string w3.org
string(本地化) 与字符串相同,但具有支持本地化的localepronunciation等attribute属性。 xsd:string w3.org
token 与字符串类似,但必须将和号和尖括号进行转义。所有空白区都要折叠到同一行。 xsd:token w3.org
anyURI URL,如https://amazon.com/zh xsd:anyURI w3.org

创建您的目录文件

有关CDF目录文件结构和元素交互方式的概述,请参阅步骤1: 创建您的目录文件


Last updated: 2023年12月18日