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