Asset Status API を使用すると、本の出版に必要な配信や、各配信の現在のステータス (成功、失敗、欠落など) を確認でき、そうでない場合はその理由も確認できます。 Slate を手動で確認する代わりに、アセット配信データを自社のシステムに一元管理することで、すべての配信とアセットタイプをリアルタイムで把握できます。 アセットステータス API を使用して、Slate の「アセット」タブで現在利用可能なデータをすべて表示できます。
アセットステータス API を使用する理由
- 一元的な運用 — アセット配信データを他の流通チャネルと並行して自社のシステムに直接取り込むことができるため、ステータスチェックのたびにSlateにログインする必要はありません
- 問題解決の迅速化 — 配信の問題を即座に検出し、タイトルの公開を妨げている原因を把握できるため、解決時間を短縮できます。
- 積極的な資産管理 — あらゆる地域や資産タイプにわたってカタログ全体をプログラム的に監視できるため、ビジネスの成長に合わせて事業を拡大できます。
- リアルタイムの配送検証 — 資産が正常に配送されたときや、対処が必要なエラーが発生したかどうかを即座に把握できます。
リクエストフォーマット
Asset Sステータス API は GET リクエスト構造による単純な取得を使用します。この構造では、すべてのクエリパラメータが URL を介して渡されるため、リクエスト本文は不要です。 これにより、システムへの統合や標準の HTTP クライアントやコマンドラインツールを使ったテストが容易になります。 タイトル識別子とオプションのフィルターを使用して URL を作成し、GET リクエストを送信するだけで、アセット配信の現在のステータスを取得できます。
https://partnerapi.primevideo.com/v1/assets/{licensor}/status/{ALID}?marketplace={marketplace}
パラメータこの表では、資産ステータス情報のクエリに使用できるパラメータを定義しています。
パラメーター |
Type |
は必須です。 |
Description |
ライセンサー |
文字列 |
はい |
オンボーディング時にプライム・Video から提供された組織識別子 |
ALID |
ストリング |
はい |
コントリビューションと一致するタイトル識別子 (ALID または SKU) |
マーケットプレイス |
文字列 |
いいえ |
タイトルが提出された Amazon マーケットプレイス。 デフォルトは GLOBALで、入力する必要はありません。 クラシックマーケットプレイスのカタログでタイトルをお探しの場合は、どのタイトルをパラメータとして指定してください。 許容値:グローバル、US、ドイツ、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
リクエストされたタイトルのアセットステータス情報を含む最上位のレスポンスです。 各レスポンスには、リクエストパラメータでフィルタリングされたステータスデータが含まれているため、さまざまなアセットタイプや要件の配送状況を把握できます。
[フィールドName] |
Type |
は必須です。 |
Description |
ソース |
配信プラットフォーム |
はい |
ソース配信プラットフォーム。 これは常にプライム・Video である必要があることに注意してください。 |
目的地 |
デリバリー/パブリッシャー |
はい |
アセットを受け取るタイトルのパートナーエイリアス。 |
スコープ |
配信範囲 |
はい |
配信範囲情報 |
プラットフォーム ID |
プラットフォーム識別子 |
はい |
プラットフォーム識別子 |
全体的な進捗コード |
プログレスコード |
はい |
全体の進行状況コード:準備完了、案件、処理中、不明 |
進捗状況詳細 |
進捗詳細項目 [] |
はい |
進捗状況の詳細一覧 |
タイトル/パーツ/ステータス |
製品タイトルパーツステータス [] |
はい |
タイトルパーツのステータス情報 |
指示 |
製品配送指示 [] |
いいえ |
配送説明書 |
配信プラットフォームType
ソース配信プラットフォーム情報。
[フィールドName] |
Type |
は必須です。 |
Description |
プラットフォーム |
ストリング |
はい |
ソース配信プラットフォーム。 これは常にプライム・Video である必要があることに注意してください。 |
配信/パブリッシャType
送信先パブリッシャー情報。 これにより、組織をコンテンツ受信者として識別できます。
[フィールドName] |
Type |
は必須です。 |
Description |
パブリッシャー |
文字列 |
はい |
アセットを受け取るタイトルのパートナーエイリアス。 |
DeliveryScope Type
アセットステータスクエリのコンテキストを定義する配信スコープ情報。
[フィールドName] |
Type |
は必須です。 |
Description |
ALID |
ストリング |
はい |
アセットの論理Identifier または SKU |
マーケットプレイス |
文字列 |
はい |
タイトルが提出された Amazon マーケットプレイス。 デフォルトは GLOBALで、入力する必要はありません。 |
Region |
文字列 |
いいえ |
Region または地域 |
FormatProfile |
文字列 |
いいえ |
視聴可能な動画の品質。 許容値:SD、HD、UHD、最大 |
LicenseType |
文字列 |
いいえ |
許容値:VOD、VOD、EST、POST、VOD |
ベネフィット ID |
ストリング |
いいえ |
チャンネルまたはサブスクリプションのIdentifier (SVOD オファーには必須) |
PlatformIdentifiers Type
タイトル識別子を含むプラットフォーム識別子構造。
[フィールドName] |
Type |
必須 |
Description |
GTI |
ストリング |
はい |
グローバルタイトルIdentifier |
パブリッシャー ID |
パブリッシャー ID [] |
はい |
パブリッシャー識別子 |
パブリッシャー識別子Type
パートナーが提供した ID のリスト。
[フィールドName] |
Type |
必須 |
Description |
ALID |
ストリング |
はい |
タイトルIdentifier |
マーケットプレイス |
文字列 |
はい |
タイトルが提出された Amazon マーケットプレイス。 デフォルトは GLOBALで、入力する必要はありません。 |
progressCode Type
アセット配信の全体的なステータスを示す進捗コード列挙値。
Value |
Description |
準備完了 |
アセットは取り込まれました。 |
問題 |
アセットの配信または処理に問題がある |
処理中 |
アセットの配送と処理が行われています。 |
行方不明です |
特定のアセットはまだ納品されていません。 |
ProgressDetailItem Type
概要統計を提供する進捗詳細項目構造。
[フィールドName] |
Type |
必須 |
Description |
進捗状況 |
プログレスコード |
はい |
プログレスコード |
合計 |
ロング |
はい |
アセットの総数 |
アクションが必要です。 |
ロング |
はい |
合計Number からアクションが必要なアセットの数 |
ProductTitlePartStatus Type
必要な単一のアセット配信のステータスを表すコアデータ構造。 これには、配送状況、アクション要件、詳細なトランザクションレベルのデータが含まれます。
[フィールドName] |
Type |
は必須です。 |
Description |
プライマリタイプ |
文字列 |
はい |
アセットの主要Type |
2 次タイプ。 |
文字列 |
はい |
セカンダリtype-たとえば、プライマリtype が IMAGE の場合、サブタイプは 2x3 または Poster になります。 |
FormatProfile |
文字列 |
いいえ |
フォーマット、プロファイル、または品質 |
ロケール |
文字列 |
いいえ |
ロケール-例:en-US、または es-419 |
オファーコンテキスト |
配信範囲 [] |
はい |
各 OfferContext は、アセットを使用する特定のオファー構成 (リージョン、ライセンtype、フォーマット、プロファイルなど) を表します。 |
条件付き/タイトル/パーツ |
商品コンディショナルタイトルパート [] |
いいえ |
コンディショナルタイトルパーツ |
ルールタイプ |
文字列 |
はい |
ルールtype: 必須、推奨、条件付き |
アクションタイプ |
文字列 |
はい |
アクションtype |
ルール/ソース |
文字列 [] |
はい |
ルールソース |
最終配信 |
製品配送 |
いいえ |
最終配送情報 |
前回の配信成功 |
製品配送 |
いいえ |
以前に正常に配信された情報 |
初回の配達日 |
文字列 |
いいえ |
初回の配達日 |
進捗状況 |
プログレスコード |
はい |
進行状況コード:準備完了、案件、処理中、不明 |
予定日 |
文字列 |
いいえ |
配送予定日 |
最も早い開始日 |
文字列 |
いいえ |
最も早い開始日 |
一般的な PrimaryType 値 PrimaryType
フィールドは、配送されるアセットのカテゴリを識別します。
Value |
Description |
メタデータ |
タイトルメタデータ (説明、キャスト、クルーなど) |
ビデオ |
Video メザニンファイル |
画像 |
アートワーク (ボックスアート、カバーアート、ヒーローイメージ、ポスター) |
オーディオ |
Audio トラック |
TIMED_TEXT |
字幕とキャプション |
一般的な ActionType 値
ActionType フィールドには、特定のアセット配信に対してアクションを実行する必要があるかどうかが示されます。
Value |
Description |
アクション_必要 |
アセットが欠落しているか、タイトルを公開するには解決しなければならないエラーがあります |
アクション_推奨 |
アセットは必須ではありませんが、カスタマーエクスペリエンスの向上のために推奨されます。 |
アクション不要 |
アセットは正常に配信されました。アクションは不要です。 |
RuleType の一般的な値
RuleType フィールドは、本を出版する際にアセットが必須か任意かを定義します。
Value |
Description |
必須 |
タイトルを出版するには配信する必要があります |
推奨 |
必須ではないが、カスタマーエクスペリエンスは向上する |
条件付き |
特定の条件が満たされる場合のみ必須 |
ProductConditionalTitlePart Type
アセット配信の条件付き要件を定義する条件付きタイトルパーツ構造。
[フィールドName] |
Type |
は必須です。 |
Description |
ルールタイプ |
文字列 |
はい |
ルールtype |
リージョン |
文字列 [] |
はい |
地域または地域のリスト |
タイトルパーツ |
商品タイトルパーツ記述子 [] |
はい |
タイトルパーツ |
RuleType 値
RuleType フィールドは、条件付きタイトル部分間の論理的な関係を定義します。
Value |
Description |
ネストされた |
構造すべてタイトル部分が満たされている必要があります (AND ロジック) |
単一 |
タイトル部分のどれかが要件 (OR ロジック) を満たしている |
ProductTitlePartDescriptor Type
特定のタイトルパーツ要件を定義するタイトルパーツ記述子構造。
[フィールドName] |
Type |
は必須です。 |
Description |
プライマリタイプ |
文字列 |
はい |
アセットの主要Type |
2 次タイプ。 |
文字列 |
はい |
セカンダリtype-たとえば、プライマリtype が IMAGE の場合、サブタイプは 2x3 または Poster になります。 |
FormatProfile |
文字列 |
いいえ |
フォーマット、プロファイル、または品質 |
ロケール |
文字列 |
いいえ |
ロケール-例:en-US、または es-419 |
製品提供Type
: 資産配送に関する詳細情報を提供する製品配送情報。 アセットがまだ配送されていない場合、このフィールドは NULL になります。
[フィールドName] |
Type |
は必須です。 |
Description |
ステータス |
ストリング |
いいえ |
配信ステータス-「未配送」または「正常に配信されました」 |
ファイル名 |
文字列 |
いいえ |
[ファイル名] |
Hash |
ストリング |
いいえ |
ファイルハッシュまたはチェックサム |
配信日 |
文字列 |
いいえ |
ISO 8601 フォーマットでの納品日 |
ロケール |
文字列 |
いいえ |
ロケール |
ServiceProvider |
文字列 |
いいえ |
サービスプロバイダーまたは配送アカウント |
プレゼンテーションタイプ |
文字列 |
いいえ |
Presentation type |
ダイナミックレンジタイプ |
文字列 |
いいえ |
ダイナミックレンジtype |
説明書 |
製品配送指示 [] |
いいえ |
配送指示またはエラー |
一般的なステータス値
「ステータス」フィールドには、アセット配信が正常に受領され処理されたかどうかが表示されます。
Value |
Description |
正常に配信されました |
アセットは正常に配信され、処理されました。 |
未配送 |
アセットは受領されていません |
ProductDeliveryInstruction Type
エラーコードとステータス情報を提供する製品配送指示構造。 インストラクションは、最上位のレスポンス (配信に関するすべての問題を要約) に表示することも、ProductDelivery オブジェクト内 (個々のアセットの配信に固有) に表示することもできます。
[フィールドName] |
Type |
は必須です。 |
Description |
タイトル/パーツ |
製品タイトル/パーツ記述子 |
いいえ。 |
タイトルパーツ記述子 |
タイトルパーツステータス |
文字列 |
いいえ |
タイトルパーツの配送状況 |
エラーコード |
文字列 |
いいえ |
エラーコード |
リージョン |
文字列 [] |
いいえ |
地域または地域のリスト |
一般的な TitlePartStatus 値
TitlePartStatus フィールドは、インストラクションメッセージ内のアセットの配信ステータスを示します。
Value |
Description |
未配送 |
アセットは配送されていません |
正常に配信されました |
アセットは正常に配信されました。 |
注:上記のスキーマは現在の API レスポンス構造を表しており、今後のリリースで強化される可能性があります。
例 2: 必要な資産が不足している
この例は、必要なアセットがない場合の API レスポンスを示し、API が ACTION_NEEDED ステータスを示し、エラー情報を提供する方法を示しています。
{
"Destination": {
"Publisher": "1cendgametestpartner1"
},
"Instructions": [
{
"ErrorCode": null,
"Regions": null,
"TitlePart": {
"FormatProfile": "SD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
},
"TitlePartStatus": "NOT_DELIVERED"
},
{
"ErrorCode": null,
"Regions": null,
"TitlePart": {
"FormatProfile": "HD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
},
"TitlePartStatus": "NOT_DELIVERED"
},
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": {
"FormatProfile": null,
"Locale": "ja",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
},
"TitlePartStatus": "SUCCESSFULLY_DELIVERED"
}
],
"OverallProgressCode": "Issue",
"ProgressDetail": [
{
"ActionNeeded": 0,
"Progress": "Ready",
"Total": 8
},
{
"ActionNeeded": 2,
"Progress": "Missing",
"Total": 2
}
],
"Scope": {
"ALID": "TLCPVAPITVSKU001EP4",
"BenefitID": null,
"FormatProfile": null,
"LicenseType": null,
"Marketplace": "GLOBAL",
"Region": null
},
"TitlePartStatus": [
{
"ActionType": "ACTION_NEEDED",
"ConditionalTitleParts": [
{
"Regions": ["DE", "PR", "AU", "JP", "GB", "US", "CA"],
"RuleType": "NESTED",
"TitleParts": [
{
"FormatProfile": "SD",
"Locale": null,
"PrimaryType": "VIDEO",
"SecondaryType": "MEZZ"
}
]
}
],
"EarliestStartDate": "Thu Jan 09 15:00:00 UTC 2025",
"FormatProfile": "SD",
"LastDelivery": null,
"Locale": null,
"OfferContexts": [
{
"ALID": "TLCPVAPITVSKU001EP4",
"BenefitID": "Prime",
"FormatProfile": "SD",
"LicenseType": "SVOD",
"Marketplace": "GLOBAL",
"Region": "US"
}
],
"PrimaryType": "VIDEO",
"PriorSuccessfulDelivery": null,
"Progress": "Missing",
"RuleSources": ["PUBLISHING_SPEC"],
"RuleType": "REQUIRED",
"SecondaryType": "MEZZ"
},
{
"ActionType": "NO_ACTION_NEEDED",
"LastDelivery": {
"DeliveredDate": "Tue Sep 24 01:04:20 UTC 2024",
"FileName": "1cendgametestpartner1-TLCPVAPITVSKU001EP4_MEC.xml",
"Instructions": [
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": null,
"TitlePartStatus": null
}
],
"Locale": "ja-jp",
"ServiceProvider": "1cendgametestpartner",
"Status": "SUCCESSFULLY_DELIVERED"
},
"Locale": "ja",
"PrimaryType": "METADATA",
"Progress": "Ready",
"RuleType": "RECOMMENDED",
"SecondaryType": "NONE"
},
{
"ActionType": "NO_ACTION_NEEDED",
"ConditionalTitleParts": [
{
"Regions": ["DE"],
"RuleType": "SINGLE",
"TitleParts": [
{
"FormatProfile": null,
"Locale": "de",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
},
{
"FormatProfile": null,
"Locale": "en",
"PrimaryType": "METADATA",
"SecondaryType": "NONE"
}
]
}
],
"LastDelivery": {
"DeliveredDate": "Tue Sep 24 01:04:20 UTC 2024",
"FileName": "1cendgametestpartner1-TLCPVAPITVSKU001EP4_MEC.xml",
"Instructions": [
{
"ErrorCode": "mec-validation-waiting-for-parent-sku-warning",
"Regions": [],
"TitlePart": null,
"TitlePartStatus": null
}
],
"Locale": "de-de",
"ServiceProvider": "1cendgametestpartner",
"Status": "SUCCESSFULLY_DELIVERED"
},
"Locale": "de",
"PrimaryType": "METADATA",
"Progress": "Ready",
"RuleType": "RECOMMENDED",
"SecondaryType": "NONE"
}
]
}
