アセットステータスAPIを使用すると、タイトルを公開するために必要な納品内容と、それぞれの納品の現在のステータス(例:成功、失敗、未納品)を確認でき、未納品の場合はその理由も把握できます。Slateを手動で確認する代わりに、アセット納品データを独自のシステムに一元化することで、すべての納品とアセットタイプをリアルタイムで可視化できます。アセットステータスAPIを使用して、Slateのアセットタブで現在利用可能な任意のデータを表示できます。
リクエストフォーマット
アセットステータス API は、GETリクエストによるシンプルな取得構造を使用しており、すべてのクエリパラメーターはURL経由で渡され、リクエストボディは不要です。これにより、標準のHTTPクライアントまたはコマンドラインツールを使用して、システムに簡単に統合してテストできます。タイトル識別子と任意のフィルターを使ってURLを構成し、GETリクエストを送信するだけで、アセットの納品状況を取得できます。
https://partnerapi.primevideo.com/v1/assets/{licensor}/status/{ALID}?marketplace={marketplace}
この表は、アセットステータス情報のクエリに使用できるパラメータを定義しています。
パラメーター |
タイプ |
は必須です |
説明 |
licensor |
文字列 |
はい |
オンボーディング時にPrime Videoから提供されたお客様の組織識別子 |
ALID |
文字列 |
はい |
投稿内容と一致するタイトル識別子(ALIDまたはSKU) |
marketplace |
文字列 |
いいえ |
タイトルが提出されたAmazonマーケットプレイス。デフォルトはGLOBALで、指定する必要はありません。オプションのマーケットプレイスパラメーターを省略した場合、APIはそのALIDに関連付けられたすべての適用範囲に関するステータス情報を返します。 指定できる値: GLOBAL、US、DE、JP、GB |
リクエスト例
https://partnerapi.primevideo.com/v1/assets/mgm/status/skuabc123?marketplace=global
https://partnerapi.primevideo.com/v1/assets/mgm/status/skuabc123
注意: リクエストパラメータが具体的であればあるほど、レスポンスはより的を絞ったものになります。オプションのマーケットプレイスパラメータを省略すると、APIはそのALIDに関連するすべての適用可能なスコープのステータス情報を返します。
レスポンススキーマ
レスポンススキーマは、アセットステータスAPIによって返されるデータの構造を定義します。これらのデータタイプを理解しておくと、レスポンスを解析し、ステータス情報をシステムに効果的に統合するのに役立ちます。
ProductStatus
要求されたタイトルに対するアセットステータス情報を含むトップレベルのレスポンスです。各レスポンスには、リクエストパラメータによってフィルターされたステータスデータが含まれており、さまざまなアセットタイプや要件における納品状況を把握できます。
フィールド名 |
タイプ |
は必須です |
説明 |
Source |
DeliveryPlatform |
はい |
ソース納品プラットフォーム。これは常にPrime Videoである必要があることに注意してください。 |
Destination |
DeliveryPublisher |
はい |
アセットを受け取るタイトルのパートナー別名。 |
Scope |
DeliveryScope |
はい |
納品範囲情報 |
PlatformIDs |
PlatformIdentifiers |
はい |
プラットフォーム識別子 |
OverallProgressCode |
ProgressCode |
はい |
全体的な進捗コード: 準備完了、発行中、処理中、行方不明 |
ProgressDetail |
ProgressDetailItem[] |
はい |
進捗状況の詳細一覧 |
TitlePartStatus |
ProductTitlePartStatus[] |
はい |
タイトル部分のステータス情報 |
Instructions |
ProductDeliveryInstruction[] |
いいえ |
配送指示 |
DeliveryPlatform Type
ソース納品プラットフォーム情報。
フィールド名 |
タイプ |
は必須です |
説明 |
Platform |
文字列 |
はい |
ソース納品プラットフォーム。これは常にPrime Videoである必要があることに注意してください。 |
DeliveryPublisher Type
送信先公開者情報。これにより、コンテンツの受信者としてあなたの組織を識別します。
フィールド名 |
タイプ |
は必須です |
説明 |
Publisher |
文字列 |
はい |
アセットを受け取るタイトルのパートナー別名。 |
DeliveryScope Type
アセットステータスクエリのコンテキストを定義する納品範囲情報。
フィールド名 |
タイプ |
は必須です |
説明 |
ALID |
文字列 |
はい |
アセットの論理識別子またはSKU |
Marketplace |
文字列 |
はい |
タイトルが提出されたAmazonマーケットプレイス。デフォルトはGLOBALで、指定する必要はありません。 |
Region |
文字列 |
いいえ |
リージョンまたは地域 |
FormatProfile |
文字列 |
いいえ |
利用可能なビデオの画質。指定できる値: SD、HD、UHD、MAX |
LicenseType |
文字列 |
いいえ |
指定できる値: SVOD, FVOD, EST, POEST, VOD |
BenefitID |
文字列 |
いいえ |
チャンネルまたはサブスクリプションの識別子(SVODオファーには必須) |
PlatformIdentifiers Type
タイトル識別子を含むプラットフォーム識別子の構造。
フィールド名 |
タイプ |
必須 |
説明 |
GTI |
文字列 |
はい |
グローバルタイトル識別子 |
PublisherIDs |
PublisherIdentifier[] |
はい |
公開者識別子 |
PublisherIdentifier Type
パートナーが提供したIDリスト。
フィールド名 |
タイプ |
必須 |
説明 |
ALID |
文字列 |
はい |
タイトル識別子 |
Marketplace |
文字列 |
はい |
タイトルが提出されたAmazonマーケットプレイス。デフォルトはGLOBALで、指定する必要はありません。 |
ProgressCode Type
アセット納品の全体的なステータスを示す進捗コードの列挙値。
値 |
説明 |
Ready |
アセットが取り込まれました |
Issue |
アセットの納品または処理に問題がある |
In-Process |
アセットの納品と処理中 |
Missing |
特定のアセットがまだ納品されていません |
ProgressDetailItem Type
進捗詳細項目の構造で、要約統計情報を提供します。
フィールド名 |
タイプ |
必須 |
説明 |
Progress |
ProgressCode |
はい |
進捗コード |
Total |
Long |
はい |
アセットの総数 |
ActionNeeded |
Long |
はい |
合計数のうち、アクションが必要なアセットの数 |
ProductTitlePartStatus Type
必要な単一のアセット納品のステータスを表すコアデータ構造。これには、納品ステータス、アクション要件、詳細なトランザクションレベルのデータが含まれます。
フィールド名 |
タイプ |
は必須です |
説明 |
PrimaryType |
文字列 |
はい |
アセットのプライマリタイプ |
SecondaryType |
文字列 |
はい |
セカンダリタイプ-たとえば、プライマリタイプが画像の場合、サブタイプは2x3またはポスターになります。 |
FormatProfile |
文字列 |
いいえ |
フォーマットプロフィールまたは品質 |
Locale |
文字列 |
いいえ |
ロケール-例:英語/米国、またはes-419 |
OfferContexts |
DeliveryScope[] |
はい |
各オファーコンテクストは、アセットを使用する特定のオファー構成(リージョン、ライセンスタイプ、フォーマットプロフィールなど)を表します |
ConditionalTitleParts |
ProductConditionalTitlePart[] |
いいえ |
条件付きタイトル部分 |
RuleType |
文字列 |
はい |
ルールタイプ: 必須、推奨、条件付き |
ActionType |
文字列 |
はい |
アクションタイプ |
RuleSources |
文字列[] |
はい |
ルールソース |
LastDelivery |
ProductDelivery |
いいえ |
最終納品情報 |
PriorSuccessfulDelivery |
ProductDelivery |
いいえ |
以前の納品成功情報 |
FirstDeliveryDate |
文字列 |
いいえ |
初回の納品日 |
Progress |
ProgressCode |
はい |
進捗コード: 準備完了、発行中、処理中、行方不明 |
ExpectedDate |
文字列 |
いいえ |
配信予定日 |
EarliestStartDate |
文字列 |
いいえ |
最短開始日 |
一般的なPrimaryTypeの値
プライマリタイプフィールドは、納品されるアセットのカテゴリを識別します。
値 |
説明 |
METADATA |
タイトルメタデータ(説明、キャスト、クルーなど) |
VIDEO |
ビデオメザニンファイル |
IMAGE |
アートワーク(ボックスアート、カバーアート、ヒーロー画像、ポスター) |
AUDIO |
オーディオトラック |
TIMED_TEXT |
字幕とキャプション |
一般的な ActionType の値
アクションタイプフィールドは、特定のアセット納品に対してアクションを実行する必要があるかどうかを示します。
値 |
説明 |
ACTION_NEEDED |
アセットが欠落しているか、公開のために解決が必要なエラーがあります。 |
ACTION_RECOMMENDED |
アセットは必須ではありませんが、カスタマーエクスペリエンスの向上のために推奨されます |
NO_ACTION_NEEDED |
アセットは正常に納品されました。アクションは不要です |
一般的なRuleType の値
ルールタイプフィールドは、タイトルを納品する際にアセットが必須かオプションかを定義します。
値 |
説明 |
required |
タイトルを公開するには納品する必要があります |
recommended |
必須ではありませんが、カスタマーエクスペリエンスを向上させます。 |
conditional |
特定の条件が満たされている場合にのみ必須 |
ProductConditionalTitlePart Type
アセット納品の条件付き要件を定義する条件付きタイトル部分構造。
フィールド名 |
タイプ |
は必須です |
説明 |
RuleType |
文字列 |
はい |
ルールタイプ |
Regions |
文字列[] |
はい |
リージョンまたは地域のリスト |
TitleParts |
ProductTitlePartDescriptor[] |
はい |
タイトル部分 |
RuleType
ルールタイプフィールドは、条件付きタイトル部分間の論理的な関係を定義します。
値 |
説明 |
NESTED |
構造内のすべてのタイトル部分を満たす必要があります(AND論理) |
SINGLE |
いずれかのタイトルパートを満たせば要件を満たします(OR 論理) |
ProductTitlePartDescriptor Type
特定のタイトル部分要件を定義するタイトル部分記述子構造。
フィールド名 |
タイプ |
は必須です |
説明 |
PrimaryType |
文字列 |
はい |
アセットのプライマリタイプ |
SecondaryType |
文字列 |
はい |
セカンダリタイプ-たとえば、プライマリタイプが画像の場合、サブタイプは2x3またはポスターになります。 |
FormatProfile |
文字列 |
いいえ |
フォーマットプロフィールまたは品質 |
Locale |
文字列 |
いいえ |
ロケール-例:英語/米国、またはes-419 |
ProductDelivery Type
アセットの納品に関する詳細情報を提供する製品納品情報。アセットがまだ納品されていない場合、このフィールドはnullになります。
フィールド名 |
タイプ |
は必須です |
説明 |
Status |
文字列 |
いいえ |
納品状況-未納品または正常に納品されました |
FileName |
文字列 |
いいえ |
ファイル名 |
Hash |
文字列 |
いいえ |
ファイルハッシュまたはチェックサム |
DeliveredDate |
文字列 |
いいえ |
ISO 8601フォーマットでの納品日 |
Locale |
文字列 |
いいえ |
ロケール |
ServiceProvider |
文字列 |
いいえ |
サービスプロバイダーまたは納品アカウント |
PresentationType |
文字列 |
いいえ |
プレゼンテーションタイプ |
DynamicRangeType |
文字列 |
いいえ |
ダイナミックレンジタイプ |
Instructions |
ProductDeliveryInstruction[] |
いいえ |
納品指示またはエラー |
一般的なStatusの値
ステータスフィールドには、アセット納品が正常に受領され処理されたかどうかが示されます。
値 |
説明 |
SUCCESSFULLY_DELIVERED |
アセットは正常に納品され、処理されました |
NOT_DELIVERED |
アセットは納品されていません |
ProductDeliveryInstruction Type
エラーコードとステータス情報を提供する製品納品指示構造。指示は、最上位の応答(すべての納品の問題をまとめたもの)に表示することも、製品納品オブジェクト内(個々のアセットの納品に固有)に表示することもできます。
フィールド名 |
タイプ |
は必須です |
説明 |
TitlePart |
ProductTitlePartDescriptor |
いいえ |
タイトル部分記述子 |
TitlePartStatus |
文字列 |
いいえ |
タイトル部分の配信状況 |
ErrorCode |
文字列 |
いいえ |
エラーコード |
Regions |
文字列[] |
いいえ |
リージョンまたは地域のリスト |
一般的なTitlePartStatusの値
タイトル部分ステータスフィールドには、指示メッセージ内のアセットの納品ステータスが表示されます。
値 |
説明 |
NOT_DELIVERED |
アセットは納品されていません |
SUCCESSFULLY_DELIVERED |
アセットは正常に納品されました |
注意: 上記のスキーマは現在のAPIレスポンス構造を表しており、今後のリリースで強化される可能性があります。
