Prime VideoアベイルズAPIはコンテンツAPIスイートの一部であり、コンテンツ権利管理システムとの直接統合を通じて、Prime Videoでのタイトルの利用可能状況を管理できます。従来のファイルアップロードよりもはるかに高い精度と制御性により、利用可能枠の提出、更新、取得、削除を行えます。
アベイルズAPIを使用する理由
APIはコンテンツ管理ワークフローを効率化し、Prime Videoカタログの管理を強化します。
- 管理の自動化 - 利用可能枠の送信と更新を自動化することで、手動アップロードを排除してエラーを減らし、チームが戦略作業に集中できるようになります
- 効率性の向上 - データセット全体を再送信せずに特定の利用可能枠を更新できるため、重複処理を減らし、時間を節約できます。
- 直接フィードバック - データをリアルタイムで検証してすぐにエラーメッセージを受け取れます。Slateにログインして手動で修正する必要がありません。
- 相互運用性 - 言語、システム、プラットフォームに依存しないRESTインターフェースを基盤とし、インターネット接続されたあらゆるシステムからアクセスできます。
API操作とエンドポイント
すべてのエンドポイントは言語に依存せず、インターネット接続されたどのシステムからでもHTTP 1.1経由でアクセスできます。アベイルズエンドポイントは特定プロトコルに従わないため、ワークフローのニーズに基づく任意の順序で呼び出せます。
抽出モデルについて
抽出モデルは、利用可能状況データをどのように構築してPrime Videoに送信するかを定義します。完全なカタログ情報を送信するか、必要な特定の変更のみを送信するかの選択、といったものです。
What Extract Models are available?
操作1 - アベイルズを作成/更新する
- 行うこと: タイトルに利用可能枠を新たに追加または既存のものを更新します。
- 必要な理由: これが、コンテンツをお客様に提供する期間と場所をPrime Videoに伝える方法です。新規コンテンツを公開する場合も、既存ライセンスを延長する場合も、この操作により利用可能状況データが最新の状態に保たれます。
操作2 - アベイルズを取得する
- 行うこと: Prime Videoのシステムから現在の利用可能状況情報を取得します。
- 必要な理由: Prime Videoが保持している利用可能状況データの確認や、不一致が生じた際のトラブルシューティング、レポート作成や照合を目的としたデータ取得を行えます。
操作3 - アベイルズを検証する
- 行うこと: Prime Videoのライブシステムに送信する前に、利用可能状況データにエラーがないかチェックします。
- 必要な理由: コンテンツの利用可能状況に影響が及ぶ前に、フォーマットエラー、必須項目の不備、ビジネスルール違反を検出します。これにより、送信して処理を待った後に、エラーの修正と再送信を行うという必要がなくなり、時間を節約できます。
操作4 - アベイルズを削除する
- 行うこと: Prime Videoのシステムから利用可能枠を削除します。
- 必要な理由: 利用可能状況を期限切れにするのではなく、完全に削除する必要があるといった、例外的なケースに対処できます。
- 重要: 1度限りのユースケース以外では、削除するのではなく終了日を調整してコンテンツを期限切れにすることが強く推奨されます。期限切れにすると、履歴データと監査記録が保持されます。
ContractIdとChannelIdentityのクエリパラメータは条件付きで、BusinessLineによって異なります。特定のビジネスラインで許可されていないパラメータを送信すると、400エラーが返されます。
BusinessLine |
ContractID |
ChannelIdentity |
TVOD |
省略 |
省略 |
FVOD |
省略 |
省略 |
PRIME_SUBSCRIPTION |
必須 — CPH、FIXED_FEE、またはFIXED_FEE:{Deal ID} |
省略 |
CHANNELS |
省略 |
必須 — チャンネル/サブスクリプションID(例:vixplusus) |
HTTPレスポンスコード
すべてのアベイルズエンドポイントは、APIリクエストの成功や失敗、およびエラーが一時的(再試行可能)か永続的かを伝える標準的HTTPステータスコードを返します。これにより、システムは手動介入なしで自動的にレスポンスを処理できるようになります。
HTTPコード |
説明 |
再試行可能 |
200 |
API呼び出しが成功しました。呼び出し側はレスポンスオブジェクトで追加の詳細をチェックする必要があります。 |
該当なし |
400 |
検証失敗を含む不正なリクエスト。 |
No |
401 |
許可されていません。 |
No |
403 |
禁止。リクエストは認証されていますが、呼び出し元にはこの操作を行う権限がありません。同じ認証情報を再送信しても解決しません。 |
No |
404 |
見つかりません。 |
No |
500 |
内部エラー。 |
Yes |
503 |
依存関係エラー。 |
Yes |
注意: 再試行可能なエラー(500、503)の場合は、試行の間に適切な遅延が加えられた再試行ロジックを実行してください。再試行不可のエラー(400、401、403、404)は、リクエストに問題があることを示しており、再送信前に修正が必要です。
APIスキーマ
このドキュメントで概説されているスキーマは、開発者がアベイルズAPIと連携するのに役立つ設計となっています。すべてのペイロードスキーマは、MDDF API v2.6標準規格に準拠しています。ペイロードにはMDDF API v2.6の任意の属性を含められますが、Prime Videoが処理するのはサポート対象の属性のみで、サポート対象外の属性は無視されます。
注意: EMAアベイルズ仕様に準拠したサポート対象の属性の全一覧については、以下の「コアデータ型」表のEMAアベイルズ列を参照してください。Prime Video全体におけるアベイルズの管理と使用方法については、コンテンツ権ページを参照してください。
MDDF XMLからJSONへの変換
MDDFアベイルズAPIは、スキーマをXML形式で定義していますが、XMLとJSONの両方のペイロードをサポートします。Prime VideoアベイルズAPIは、JSONでエンコードされたペイロードを使用します。MDDF XMLをJSONに変換するプロセスの概要は、次のとおりです。
名前空間は省略されます
<alice>bob</alice>
becomes
{ "alice": "bob" }
ネストされた要素が、ネストされたプロパティになります
<alice><bob>charlie</bob><david>edgar</david></alice>
becomes
{ "alice": { "bob": "charlie", "david": "edgar" } }
同じ名前の複数の要素は配列要素になります
<alice><bob>charlie</bob><bob>david</bob></alice>
becomes
{ "alice": { "bob": [ "charlie", "david" ] } }
属性はプロパティに入り、先頭にアンダースコアが付きます
<alice charlie="david">bob</alice>
becomes
{ "alice": { "_charlie": "david", "value": "bob" } }
一般的なスキーマデータ型
アベイルズAPIスキーマは、次のデータ型をサポートしています。
| 型 |
説明 |
| ブーリアン |
ブーリアン型。指定できる値:true、false |
| 整数 |
32ビットの符号付き整数。 |
| 長整数 |
64ビットの符号付き整数。 |
| 小数 |
浮動小数点数。 |
| 文字列 |
文字の配列。 |
| タイムスタンプ |
ISOタイムスタンプ。 |
| 列挙 |
あらかじめ定義された許容値のセットを含む列挙文字列。 |
| 構造体 |
構造体は他の属性を集約する役割を担う。 |
| 配列 |
同じ型の要素の集合。[]で指定される。 |
注意: バッチリクエストで指定できる要素の最大数は、100に制限されています。
リクエストとレスポンススキーマ
このセクションでは、すべてのアベイルズAPI操作のデータ構造を定義します。これらのスキーマは、Prime Videoに送信するリクエストと、受信するレスポンスの正確な形式を指定します。これらの構造を理解することは、API統合を成功させるために不可欠です。
スキーマ1 - アベイルズを作成/更新する
これらのスキーマは、Prime Videoのシステムで利用可能枠を作成または更新する構造を定義します。新しいコンテンツの権利を送信したり、既存のものを変更したりする場合に使用します。
PutAvailsAPIRequest型
単一の利用可能枠を送信するための主要リクエストオブジェクト。
属性 |
型 |
必須 |
説明 |
avail |
アベイルズ |
はい |
利用可能状況データ - これは、PUTリクエストまたはバリデーションリクエストの最上位属性です |
PutAvailsAPIResponse型
利用可能枠を送信した後に受け取るレスポンス。操作が完了したことを確認するには成功フィールドをチェックし、送信に失敗した場合はエラーを確認します。
属性 |
型 |
必須 |
説明 |
success |
ブーリアン |
はい |
操作ステータス |
errors |
Error[] |
いいえ |
失敗した場合のエラーの一覧 |
PutAvailsBatchAPIRequest型
このスキーマは、単一のAPI呼び出しで複数の利用可能枠を送信する必要がある場合に使用します。バッチ操作により、大規模なカタログの管理や一括更新を行う際の効率を向上させます。
属性 |
型 |
必須 |
説明 |
requestItems |
PutAvailsBatchAPIRequestItem[] |
はい |
個々のリクエストの一覧 |
PutAvailsBatchAPIResponse型
バッチレスポンスは、バッチリクエストの各項目に対する個々の結果を返します。各レスポンス項目は、requestItemId経由のリクエスト項目に対応しています。
属性 |
型 |
必須 |
説明 |
responseItems |
PutAvailsBatchAPIResponseItem[] |
はい |
レスポンス項目の一覧 |
PutAvailsBatchAPIRequestItem型
バッチリクエストの各項目には、操作タイプ(完全抽出)と対象リソースを指定する一意の識別子とパスが必要です。
属性 |
型 |
必須 |
説明 |
requestItemId |
文字列 |
はい |
バッチリクエスト内の項目の一意の識別子。バッチ内の各項目を識別するために使用する一意の文字列であり、当社からのバッチレスポンスにリンクされます。 |
path |
文字列 |
はい |
このリクエスト項目のリソースへのパス。 |
body |
PutAvailsBatchAPIRequestItemBody |
はい |
利用可能状況データ |
PutAvailsBatchAPIRequestItemBody型
各バッチリクエスト項目のボディには、送信する実際の利用可能状況データが含まれます。
属性 |
型 |
必須 |
説明 |
avail |
アベイルズ |
はい |
利用可能状況データ |
PutAvailsBatchAPIResponseItem型
バッチ内の各レスポンス項目は、対応するリクエストの成功や失敗を示します。requestItemIdを使用して、レスポンスを元のリクエストと照合できます。
属性 |
型 |
必須 |
説明 |
requestItemId |
文字列 |
はい |
バッチリクエスト内の項目の一意の識別子 |
success |
ブーリアン |
はい |
操作ステータス |
errors |
Error[] |
いいえ |
失敗した場合のエラーの一覧 |
スキーマ2 - アベイルズを取得する
これらのスキーマは、Prime Videoのシステムから既存の利用可能枠を取得する方法を定義します。これらを使用すると、コンテンツの現在の権利情報を照会できます。
GetAvailsAPIResponse型
レスポンスには、すべてのライセンス条件と地域権を含む、リクエストされたコンテンツの完全な利用可能状況データが含まれています。
属性 |
型 |
必須 |
説明 |
avail |
アベイルズ |
はい |
利用可能状況データ |
success |
ブーリアン |
はい |
操作ステータス |
errors |
Error[] |
いいえ |
失敗した場合のエラーの一覧 |
GetAvailsBatchAPIRequest
単一のAPI呼び出しで複数の利用可能枠を取得します。複数のタイトルや取引の権利をチェックする必要がある場合に効率的です。
属性 |
型 |
必須 |
説明 |
requestItems |
GetAvailsBatchAPIRequestItem[] |
はい |
個々のリクエストの一覧 |
GetAvailsBatchAPIResponse
リクエストされた各項目の利用可能状況データを返します。各レスポンスはrequestItemId経由のリクエストに対応しています。
属性 |
型 |
必須 |
説明 |
responseItems |
GetAvailsBatchAPIResponseItem[] |
はい |
レスポンス項目の一覧 |
GetAvailsBatchAPIRequestItem
GETリクエストの各項目には、取得したいリソースへのパスが指定されます。
属性 |
型 |
必須 |
説明 |
requestItemId |
文字列 |
はい |
バッチリクエスト内の項目の一意の識別子 |
path |
文字列 |
はい |
このリクエスト項目のリソースへのパス。 |
GetAvailsBatchAPIResponseItem
各レスポンス項目には、取得が成功した場合は利用可能状況データが、失敗した場合にはエラーの詳細が含まれます。
属性 |
型 |
必須 |
説明 |
requestItemId |
文字列 |
はい |
バッチリクエスト内の項目の一意の識別子 |
success |
ブーリアン |
はい |
操作ステータス |
errors |
Error[] |
いいえ |
失敗した場合のエラーの一覧 |
avail |
アベイルズ |
いいえ |
アベイルズオブジェクト |
スキーマ3 - アベイルズを検証する
これらのスキーマを使用すると、Prime Videoのシステムに送信する前に、利用可能状況データをテストできます。検証により、利用可能枠を実際に作成または変更せずに、エラーを早期に検出できます。
ValidateAvailsAPIRequest型
属性 |
型 |
必須 |
説明 |
avail |
アベイルズ |
はい |
利用可能状況データ |
ValidateAvailsAPIResponse型 検証レスポンスは、データがすべての検証ルールに合格しているかどうかを示します。実際の作成または更新リクエストを送信する前に、エラーがないか確認します。
属性 |
型 |
必須 |
説明 |
success |
ブーリアン |
はい |
操作ステータス |
errors |
Error[] |
いいえ |
失敗した場合のエラーの一覧 |
ValidateAvailsBatchAPIRequest型 単一の呼び出しで複数の利用可能枠を検証します。特に、大量のバッチ処理を準備する際に役に立ちます。
属性 |
型 |
必須 |
説明 |
requestItems |
ValidateAvailsBatchAPIRequestItem[] |
はい |
個々のリクエストの一覧 |
ValidateAvailsBatchAPIResponse型
バッチ内の各項目に対して検証結果を返します。各レスポンスはrequestItemId経由のリクエスト項目に対応しています。
属性 |
型 |
必須 |
説明 |
responseItems |
ValidateAvailsBatchAPIResponseItem[] |
はい |
レスポンス項目の一覧 |
ValidateAvailsBatchAPIRequestItem型
検証リクエストの各項目では、実際の作成や更新の操作と区別するため、リソースパスに/validateが付けられます。
属性 |
型 |
必須 |
説明 |
requestItemId |
文字列 |
はい |
バッチリクエスト内の項目の一意の識別子 |
path |
文字列 |
はい |
リクエストのリソースへのパス: |
body |
ValidateAvailsBatchAPIRequestItemBody |
はい |
リクエストボディ |
ValidateAvailsBatchAPIRequestItemBody型 検証対象の利用可能枠データが含まれます。
属性 |
型 |
必須 |
説明 |
avail |
アベイルズ |
はい |
利用可能状況データ |
ValidateAvailsBatchAPIResponseItem型 検証レスポンスの各項目は、対応するデータが検証チェックに合格したかどうかを示します。
属性 |
型 |
必須 |
説明 |
requestItemId |
文字列 |
はい |
バッチリクエスト内の項目の一意の識別子 |
success |
ブーリアン |
はい |
操作ステータス |
errors |
Error[] |
いいえ |
失敗した場合のエラーの一覧 |
スキーマ4 - アベイルズを削除する
これらのスキーマは、Prime Videoのシステムから利用可能枠を削除する方法を定義します。
重要: コンプライアンス要件への対応といった特定のユースケースを除き、削除するのではなく終了日を調整してコンテンツを期限切れにすることが強く推奨されます。期限切れにすると、レポート作成や照合に有用な履歴データと監査証跡が保持されます。
DeleteAvailsAPIResponse型
削除操作が正常に完了したかどうかを確認します。成功フィールドをチェックして、エラーがないか確認します。
属性 |
型 |
必須 |
説明 |
success |
ブーリアン |
はい |
操作ステータス |
errors |
Error[] |
いいえ |
失敗した場合のエラーの一覧 |
DeleteAvailsBatchAPIRequest型
単一のAPI呼び出しで複数の利用可能枠を削除します。一括削除や権利失効の場合に役立ちます。
属性 |
型 |
必須 |
説明 |
requestItems |
DeleteAvailsBatchAPIRequestItem[] |
はい |
個々のリクエストの一覧 |
DeleteAvailsBatchAPIResponse型
バッチリクエストの各項目の削除結果を返します。
属性 |
型 |
必須 |
説明 |
responseItems |
DeleteAvailsBatchAPIResponseItem[] |
はい |
レスポンス項目の一覧。 |
DeleteAvailsBatchAPIRequestItem型
削除リクエストの各項目には、削除対象リソースへのパスが指定されます。
属性 |
型 |
必須 |
説明 |
requestItemId |
文字列 |
はい |
バッチリクエスト内の項目の一意の識別子 |
path |
文字列 |
はい |
このリクエスト項目のリソースへのパス。完全抽出モデルの場合の形式:/avails/{licensor}/full-extract/{ALID}?territory={Territory}&businessLine={BusinessLine}[&contractId={ContractId}][&channelIdentity={Channel}] ContractId と ChannelIdentityのクエリパラメータは条件付きで、businessLineの値によって異なります。特定のビジネスラインで許可されていないパラメータを送信すると、400エラーが返されます。下の表を参照してください。 |
DeleteAvailsBatchAPIResponseItem型
各レスポンス項目は、該当するリクエストに対応して削除が成功したかどうかを確認します。
属性 |
型 |
必須 |
説明 |
requestItemId |
文字列 |
はい |
バッチリクエスト内の項目の一意の識別子 |
success |
ブーリアン |
はい |
操作ステータス |
errors |
Error[] |
いいえ |
失敗した場合のエラーの一覧 |
コアデータ型
これらの基本的なデータ型は、APIスキーマ全体で使用されます。これらの構造を理解することは、あらゆるアベイルズの操作を扱う上で不可欠です。詳細については、コンテンツ権限ページを参照してください。
エラータイプ
操作が失敗したときに返される標準エラー構造。コードはエラータイプを特定し、メッセージは人間が読み取れる詳細情報を提供します。
属性 |
型 |
必須 |
説明 |
code |
文字列 |
はい |
エラータイプを説明する文字列。 |
メッセージ |
文字列 |
はい |
人間が読み取れるエラーの説明 |
アベイルズタイプ
完全な利用可能枠を表すコアデータ構造。コンテンツの権利、ライセンス条件、地域、およびビジネス条件に関するすべての情報を含みます。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
ALID |
文字列 |
はい |
タイトル識別子を指定します。メタデータコントリビューションで指定されるALIDと一致する必要があります。 |
ALID |
Disposition |
AvailDisposition |
はい |
抽出モデルの粒度を指定します。 |
該当なし |
Licensor |
パブリッシャー |
はい |
Prime Videoにライセンスを付与する企業に関する情報を指定します。 |
該当なし |
アセット |
AvailAsset[] |
はい |
アセットに関する情報。リストには1つのアセットのみを指定する必要があります。 |
該当なし |
取引 |
AvailTrans[] |
はい |
取引に関する情報。 |
該当なし |
SharedEntitlement |
AvailSharedEntitlement[] |
いいえ |
他のサービスの権限付与に関する情報。 |
該当なし |
AvailDisposition型
これが完全抽出操作か完全削除操作か、また、データの作成・更新を行うのか、削除を行うのかを定義します。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
EntryType |
列挙 |
はい |
指定できる値: FullExtract、FullDelete |
Disposition |
パブリッシャー型
組織をコンテンツライセンサーとして識別します。この値は、Prime Videoによりオンボーディング時に提供されます。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
DisplayName |
文字列 |
はい |
Prime Videoパートナーの名前を指定します。この値はPrime Videoによりパートナーに提供されます。EMAファイルで使用される値と同じである必要があります。 |
DisplayName |
AvailAsset型
ライセンス対象となるコンテンツアセットについて説明します。構造はWorkType (映画、エピソード、シーズンなど) によって異なります。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
_contentID |
文字列 |
はい |
このアセットのコンテンツIDを指定します。通常はALIDと同じです。 |
ContentID |
WorkType |
列挙 |
はい |
指定できる値: 映画、ショート動画、エピソード、シーズン、補足 |
WorkType |
メタデータ |
AvailUnitMetadata |
条件付き |
映画またはショート動画のメタデータを説明します。WorkTypeが映画またはショート動画の場合は必須です。 |
該当なし |
EpisodeMetadata |
AvailEpisodeMetadata |
条件付き |
エピソードのメタデータを説明します。WorkTypeがエピソードの場合は必須です。 |
該当なし |
SeasonMetadata |
AvailSeasonMetadata |
条件付き |
シーズンのメタデータを説明します。WorkTypeがシーズンの場合は必須です。 |
該当なし |
AvailSharedEntitlement型
DMA (デジタルムービーアライアンス)のような他のデジタルエコシステム向けの権利を指定します。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
_ecosystem |
列挙 |
はい |
指定できる値: DMA |
該当なし |
EcosystemID |
文字列 |
はい |
エコシステム固有のタイトル識別子 |
DMA_ID |
AvailUnitMetadata型
映画やショート動画などの単独作品コンテンツのメタデータ。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
TitleInternalAlias |
String[] |
はい |
タイトル名。リストには1つのタイトル名のみを指定する必要があります。 |
TitleInternalAlias |
AvailEpisodeMetadata型
エピソード番号や親シーズン/シリーズ情報を含む、テレビエピソード固有のメタデータ。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
TitleInternalAlias |
String[] |
はい |
エピソードのタイトル名。リストには1つのタイトル名のみを指定する必要があります。 |
EpisodeTitleInternalAlias |
EpisodeNumber |
ContentSequenceInfo |
はい |
シーズン内のこのエピソードの番号。 |
EpisodeNumber |
SeasonMetadata |
AvailSeasonMetadata |
条件付き |
シーズンのメタデータを説明します。WorkTypeがエピソードかシーズンの場合は必須です。 |
該当なし |
SeriesMetadata |
AvailSeriesMetadata |
条件付き |
シリーズのメタデータを説明します。WorkTypeがエピソードかシーズンの場合は必須です。 |
該当なし |
AvailSeasonMetadata型
シーズン番号やエピソード数を含むTVシーズンのメタデータ。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
SeasonContentID |
文字列 |
はい |
シーズンのALID。 |
SeasonContentID |
SeasonTitleInternalAlias |
String[] |
いいえ |
シーズンのタイトル名。リストには1つのタイトル名のみを指定する必要があります。 |
SeasonTitleInternalAlias |
SeasonNumber |
ContentSequenceInfo |
はい |
シリーズ内のこのシーズンの番号。 |
SeasonNumber |
NumberOfEpisodes |
整数 |
はい |
このシーズン内のエピソード数。 |
EpisodeCount |
SeriesMetadata |
AvailSeriesMetadata |
条件付き |
シリーズのメタデータを説明します。WorkTypeがシーズンの場合は必須です。 |
該当なし |
AvailSeriesMetadata型
トップレベルのシリーズ情報を提供するテレビシリーズのメタデータ。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
SeriesContentID |
文字列 |
はい |
シリーズのALID。 |
SeriesContentID |
SeriesTitleInternalAlias |
String[] |
いいえ |
シリーズのタイトル名。リストには1つのタイトル名のみを指定する必要があります。 |
SeriesTitleInternalAlias |
NumberOfSeasons |
整数 |
いいえ |
このシリーズ内のシーズン数。 |
SeasonCount |
AvailTrans型
地域、日付、ライセンスタイプ、事業条件など、特定のライセンス取引を定義します。ここで実際に付与される権利を指定します。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
_TransactionID |
文字列 |
いいえ |
利用可能枠の一意の識別子。FullExtractを使用する場合のオプションです。 |
AvailID |
LicenseType |
列挙 |
はい |
指定できる値: SVOD、FVOD、EST、POEST、VOD |
LicenseType |
地域 |
Region[] |
はい |
配信可能地域。1つの地域項目のみが提供される必要があります。1つのアベイルズオブジェクト内のすべての取引は、同じ地域である必要があります。 |
地域 |
開始 |
DateTime |
はい |
ISO形式による配信の開始日時。 注: タイムゾーンが含まれていない場合、その地域で最も東側のタイムゾーンが使用されます。ただし、特定のリリース時刻を希望する場合は、任意のタイムゾーンを含められます。 |
開始 |
終了 |
DateTime |
いいえ |
ISO形式による配信の終了日時。提供されない場合、配信期間は無制限です。 注: タイムゾーンが含まれていない場合、その地域で最も東側のタイムゾーンが使用されます。ただし、特定の終了時間を希望する場合は、任意のタイムゾーンを含められます。 |
終了 |
AssetLanguage |
AssetLanguage[] |
いいえ |
アセットの言語は、アセット型とISO言語コードを組み合わせて表されます。指定できるアセット型: subtitle、audio、subdub、sub、dub、ov、mta、any |
AssetLanguage |
AllowedLanguage |
AssetLanguage[] |
いいえ |
ISO言語コードとアセット型の組み合わせ。指定できるアセット型: subtitle、audio、sub、dub、subdub、any |
AllowedLanguages |
HoldbackLanguage |
AssetLanguage[] |
いいえ |
ISO言語コードとアセット型の組み合わせ。指定できるアセット型: subtitle、audio、sub、dub、subdub、any |
HoldbackLanguage |
LicenseRightsDescription |
文字列 |
いいえ |
公開の優先順位を指定するために使用します。 |
LicenseRightsDescription |
FormatProfile |
AvailFormatProfile |
はい |
利用可能なビデオの画質。指定できる値: SD、HD、UHD |
FormatProfile |
ContractID |
文字列 |
いいえ |
契約情報を指定します。指定できる値: |
ContractID |
条件 |
AvailTerms[] |
はい |
利用可能枠の事業条件のリストを指定します。 |
OtherTerms |
OtherInstructions |
文字列 |
いいえ |
利用可能枠に関する追加の処理指示。 |
OtherInstructions |
地域型
ISO国コードを使用して地理的地域を指定します。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
country |
文字列 |
はい |
2文字のISO 3166-1国コード |
該当なし |
AssetLanguage型
audioとsubtitleアセットの言語の利用可能状況を定義します。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
value |
文字列 |
はい |
アセットの言語は、アセット型とRFC 5646言語コードを組み合わせて表されます。 |
該当なし |
_asset |
文字列 |
いいえ |
AvailTrans型の言語属性に応じて、異なる値のセットを使用できます。 |
該当なし |
AvailFormatProfile型
利用可能状況のビデオ品質レベルを指定します。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
value |
列挙 |
はい |
利用可能なビデオの画質。指定できる値: SD、HD、UHD |
該当なし |
AvailTerms型
事業条件を指定するための柔軟な構造。各条件には名前と該当する型の値(金額、テキスト、イベント、ブーリアン、期間、または数値) が設定されます。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
_termName |
文字列 |
はい |
条件を識別します。値は大文字と小文字を区別しません。指定できる値の一覧については、以下を参照してください。 |
該当なし |
Money |
金額 |
いいえ |
詳細については、以下を参照してください。 |
該当なし |
Text |
文字列 |
いいえ |
詳細については、以下を参照してください。 |
該当なし |
Event |
DateTime |
いいえ |
詳細については、以下を参照してください。 |
該当なし |
Boolean |
ブーリアン |
いいえ |
詳細については、以下を参照してください。 |
該当なし |
Duration |
文字列 |
いいえ |
詳細については、以下を参照してください。 |
該当なし |
Number |
整数 |
いいえ |
詳細については、以下を参照してください。 |
該当なし |
金額型
通貨を指定した金額値を表します。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
value |
小数 |
いいえ |
金額値、一部の価格タイプでは必須 |
該当なし |
_currency |
文字列 |
はい |
ISO通貨コード |
該当なし |
期間型
ISO 8601期間形式を使用して期間を表します。値は時間単位で指定する必要があります。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
value |
文字列 |
はい |
ISO 8601規格における時間数。形式: PT{N}H({N}は整数の時間数)。たとえば、48時間はPT48H、30日間はPT720Hとなります。 |
該当なし |
ContentSequenceInfo型
エピソードとシーズンのシーケンス番号を指定します。
属性 |
型 |
必須 |
注記 |
EMAファイルマッピング |
Number |
整数 |
はい |
エピソード番号やシーズン番号などの、コンテンツシーケンス番号 |
該当なし |
サポート対象のアベイルズ条件(注: 右にスクロールするとEMAマッピング全体を表示できます)
以下の表は、AvailTerms配列に含められるサポート対象のすべての事業条件を一覧表示したものです。各条件は、ライセンス、価格設定、広告、およびカスタマーエクスペリエンスの特定要素を規定します。
条件名 |
属性 |
必須 |
注記 |
EMAファイルマッピング |
ChannelIdentity |
テキスト |
はい |
チャンネルまたはサブスクリプションの識別子。 |
GroupIdentity |
Tier |
テキスト |
条件付き |
価格設定階層。ライセンスタイプがPOESTの場合は必須です。 |
PriceType |
SRP |
金額 |
条件付き |
希望小売価格。ライセンスタイプがPOESTの場合は必須です。 |
SRP |
WSP |
金額 |
条件付き |
卸売価格。ライセンスタイプがPOESTの場合は必須です。 |
PriceValue |
Category |
テキスト |
条件付き |
価格区分。ライセンスタイプがPOESTの場合は必須です。 |
PriceValue |
AnnounceDate |
Event |
条件付き |
配信可能地域におけるタイトルの利用開始日を小売業者が発表できる日付。予約注文の場合は必須です。 |
AnnounceDate |
SuppressionLiftDate |
Event |
条件付き |
あるタイトルが、将来の特定の日付に配信可能地域で利用可能になることが公表できる最初の日付。ライセンスタイプがPOESTの場合は必須です。 |
SuppressionLiftDate |
RentalDuration |
Duration |
条件付き |
時間単位のレンタル期間。ライセンスタイプがSVODの場合は必須です。 |
RentalDuration |
WatchDuration |
Duration |
条件付き |
ユーザーが視聴を開始してから完了するまでに要する時間数。ライセンスタイプがSVODの場合は必須です。 |
WatchDuration |
Download |
テキスト |
いいえ |
ライセンスにダウンロードの許可が含まれます。有効な値は YesとNoです。ライセンスタイプがSVODの場合、レンタル期間と視聴期間の両方を指定する必要があります。 |
Download |
Exclusive |
ブーリアン |
いいえ |
アセットは取引の範囲内で独占されるものとなります。 |
Exclusive |
ExclusiveAttributes |
テキスト |
いいえ |
独占の種類を指定します。Exclusiveがtrueの場合にのみ考慮されます。Exclusiveがtrueで提供されない場合は、デフォルト値が使用されます。 |
ExclusiveAttributes |
BrandingRights |
ブーリアン |
いいえ |
パートナーのブランディングを表示する意向を示します。 |
BrandingRights |
BrandingRightsAttributes |
テキスト |
いいえ |
ブランディングのテキストを指定します。BrandingRightsがtrueの場合にのみ考慮されます。BrandingRightsがtrueで提供されない場合は、デフォルト値が使用されます。 |
BrandingRightsAttributes |
allowAds |
ブーリアン |
いいえ |
広告を許可するか禁止するかを決定します。この条件は1回だけ表示できます。 |
EMAでは使用できません |
allowedAdPlacement |
テキスト |
条件付き |
広告を挿入できるロール内の位置を指定します。指定できる値: PreRoll、MidRoll、PostRoll、Overlays、PauseAds、Squeezebacks。 |
EMAでは使用できません |
prohibitedAdPlacement |
テキスト |
条件付き |
広告を挿入できないロール内の位置を指定します。指定できる値: PreRoll、MidRoll、PostRoll、Overlays、PauseAds、Squeezebacks。 |
EMAでは使用できません |
cuepointDeliveryAndUsage |
テキスト |
いいえ |
キューポイントの配信と使用の義務事項を指定します。指定できる値: PartnerWillDeliverAndPrimeVideoMustUse、PrimeVideoWillUseIfDelivered、NoDeliveryOrUsageObligations、TalentObligated。 |
EMAでは使用できません |
blindBasisSelling |
テキスト |
いいえ |
指定できる値: GuaranteedImpressions、NoGuaranteedImpressions |
EMAでは使用できません |
sponsorships |
テキスト |
いいえ |
指定できる値: Permitted、Prohibited、PermittedWithRestrictions。 |
EMAでは使用できません |
sponsorshipsRestrictions |
テキスト |
条件付き |
自由形式のテキスト |
EMAでは使用できません |
talentAndAmazon (**改行を含めないこと) |
テキスト |
いいえ |
指定できる値: NoRestrictions、ConsultationRequired |
EMAでは使用できません |
talentRestrictions |
テキスト |
条件付き |
自由形式のテキスト |
EMAでは使用できません |
adLoadLimit |
テキスト |
いいえ |
1時間あたりの広告分数。値は有効な整数である必要があります。 |
EMAでは使用できません |
adKey |
テキスト |
いいえ |
自由形式のテキスト |
EMAでは使用できません |
CompleteYourBundle (**改行を含めないこと) |
Number |
いいえ |
お客様がまだ所有していない残りのタイトルを購入してセット品を完成させた際に適用される割引率。たとえば、20%割引の場合、2シーズンのセット品でシーズン1を所有しているお客様は、シーズン2を20%割引で購入できます。 |
EMAでは使用できません |
ExcludedFrom (**改行を含めないこと) |
ブーリアン |
いいえ |
trueに設定した場合、この利用可能枠はセット品割引対象から除外されます。プレミアム価格期間(例: 新作リリース時)や、定価を維持する必要があるタイトルに使用します。設定なしまたはfalseの場合、そのタイトルはセット品割引の対象となります。 |
EMAでは使用できません |
BusinessLine列挙
BusinessLine列挙は、コンテンツのライセンス供与および配信が適用されるPrime Videoビジネスモデルを指定します。これにより、お客様のコンテンツへのアクセス方法と収益の発生方法が決定されます。
値 |
説明 |
TVOD |
TVODは購入またはレンタルを意味します。関連するライセンスタイプ: EST、VOD、POEST |
PRIME_SUBSCRIPTION |
AmazonプライムまたはAmazon Kids+のサブスクリプション。関連するライセンスタイプ: SVOD |
CHANNELS |
サードパーティのサブスクリプション。関連するライセンスタイプ: SVOD |
FVOD |
無料コンテンツ。関連するライセンスタイプ: FVOD |
注: BusinessLineの値は、コンテンツ提供に適用されるビジネスモデルを決定します。アベイルズを送信する際は、BusinessLineが必ずPrime Videoとの契約内容と一致していることを確認してください。パートナーシップで利用できるBusinessLineの値についてご不明な点がございましたら、Prime Video担当者にお問い合わせください。
サンプルペイロードアベイルズ
以下の例は、一般的な統合シナリオにおけるAPI呼び出しの構築方法を示しています。こちらのペイロードの例では、統合のテンプレートとして利用できる、適切にフォーマットされたJSON形式の完全なリクエスト/レスポンスの組み合わせを参照できます。
よくある質問
以下のセクションでは、アベイルズAPIの操作に関するよくある質問への回答をご覧になれます。
一般的なAPIの使用
一般的な API の使用
コンテンツの削除と日付変更
Content removal and date changes
アベイルズの送信