開発者コンソール

カタログデータ形式(CDF)の概要


カタログデータ形式(CDF)の概要

このトピックでは、カタログデータ形式(CDF)スキーマに用意されている要素の一覧を示します。CDFスキーマを使用してメディアコンテンツのカタログを作成し、それをAmazon Fire TVにアップロードします。

カタログデータ形式(CDF)スキーマは、メディアを記述するために必要な要素を定義します。これにより、Amazonでのカタログ統合が可能になります。スキーマは、catalog.xsdファイルで定義されます。スキーマには、映画、TV番組、ブロードキャストなど、さまざまなタイプのメディアに使用される150を超える要素が含まれています。catalog.xsdファイルは以下からダウンロードできます。

Catalogスキーマのドキュメントは、次の2つの方法で確認できます。

要素でフィルタリングしたウェブページ

開発者ポータルのウェブページでは、スキーマ要素を一覧表示できます。すべての要素を一律に表示することもできますが、より実用的な方法として、一般的な親要素(Movieなど)を選択し、その要素の説明図とコードサンプルを参照することができます。

要素をフィルタリングしたウェブページ
要素をフィルタリングしたウェブページ

説明図またはコードサンプルで要素をクリックすると、説明図またはコードの下にあるウィンドウがスクロールされ、その要素の説明にフォーカスが移動します。

説明図とコードが表示される要素は以下のとおりです。

スキーマの自動生成ドキュメント

catalog.xsdファイルには、自動生成ドキュメントとして表示できるドキュメント注釈が含まれています(JavaのJavadocとよく似ています)。XSDスキーマの自動生成ドキュメントは、こちらで確認できます。catalogノードを展開し、必要に応じてその他のノードを展開してください。

スキーマの自動生成ドキュメント
スキーマの自動生成ドキュメント

catalog.xsdファイルは、Oxygen XML EditorなどのXMLエディターで直接表示することもできます。この場合は、より高度なナビゲーションコントロールが可能になります。

また、XSDファイルを直接確認して、スキーマのロジックを学ぶこともできます。XSDファイルを初めて使用する場合は、入門用のXML Schema Part 0: Primer Second Edition(英語のみ)を参照してください。より正式なXSDスキーマリファレンスドキュメントについては、XML Schema Part 1: Structures Second Edition(英語のみ)およびXML Schema Part 2: Datatypes Second Edition(英語のみ)を参照してください。

XSDファイルの内容に関するヒントを以下に示します。

XSDプロパティ 意味
xsd:element 要素を識別します。
minOccurs="0" この要素は省略可能です。
maxOccurs="unbounded" この要素は何回でも繰り返すことができます。
xsd:simpleType この要素には子要素も属性もありません。詳細については、simpleType(英語のみ)を参照してください。
xsd:complexType この要素には子要素または属性が含まれます。複合型では、子要素の順序や選択の要件、その他のロジックなどが、コンテンツモデルの記述で指定されます。詳細については、complexType(英語のみ)を参照してください。
xsd:choice 子要素の中から、含める要素を選択する必要があることを示します。このロジックでは、いずれか1つの要素を選択する必要があります(すべてを選択することはできません)。たとえば、Creditsでは、CastMemberまたはCrewMemberのいずれか一方の子項目を指定できますが、両方を指定することはできません。
xsd:sequence 子要素が指定の順序に従う必要があることを示します。たとえば、CustomerRatingでは、子要素をScoreMaxValueCountの順に指定する必要があります(Countは省略可能です)。
xsd:sequencexsd:choiceの組み合わせ 一部の要素では、sequence(順序)とchoice(選択)の両方を組み合わせて使用します。この場合は、コンテンツモデルの記述で使用方法を明示します。
xsd:annotation 要素のドキュメントを示します。カタログXSDファイルには各要素と共に注釈要素がいくつか含まれていますが、この説明は簡略的なもので、公式ドキュメントに代わるものではありません。要素に関する公式ドキュメントとしては、ウェブページ上のドキュメントを参照してください。XSDファイルの値は、各要素の意味を説明するというよりも、コンテンツモデルのロジックや必要とされる使用方法を示すことを目的としたものです。
xsd:enumeration simpleTypeの値には列挙値を使用できます。列挙型では、事前に定義されたリスト内の文字列に選択肢が制限されます。
xsd:extension base= この要素のロジックは別の要素に基づきます。この要素は、基盤となる別の要素を拡張するものです。
xsd:attribute この要素では属性を使用できます。XMLの属性については、2.2 Complex Type Definitions, Element & Attribute Declarations(英語のみ)を参照してください。

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
string 英字および数字。 xsd:string w3.org
string(ローカライズ) stringと同じですが、ローカライズ用に使用できるlocalepronunciationなどの属性があります。 xsd:string w3.org
token stringと似ていますが、アンパサンドや山かっこはエスケープする必要があります。空白はすべて同じ行に折りたたまれます。 xsd:token w3.org
anyURI https://amazon.comなどのURL。 xsd:anyURI w3.org

ダウンロード可能なCDFサンプル

CDF形式のコードサンプルは、各要素ページの [コード] タブに表示されます。このサンプルは、cdf-examples.zipファイルでダウンロードすることもできます。これらのサンプルは、カタログファイルの構成を理解するための参考にしてください。このzipファイルには、各メディアタイプとカタログ全体のCDF XMLのサンプル、および番組、シーズン、特別番組、トレーラーやクリップ、エピソードなどをひとまとめにする方法を示すサンプルが含まれています。

カタログファイルの作成

CDFカタログファイルの構造に関する概要と各要素の相互作用については、手順1: カタログファイルを作成するを参照してください。