開発者は、Prime Video SlateのレポートAPIを使用して、クライアントを構築し、使用可能なレポートタイプやそれらのレポートのダウンロードURLなど、レポート関連情報を取得できます。このセクションでは、これらのAPIの使用について説明します。
認証
SlateのレポートAPIでは、Login With Amazon（LWA）を利用してリクエストを認証します。LWAの設定方法の詳細については、LWAのドキュメントを参照してください。
リクエストには、リクエスト認証ヘッダーに有効なLWA認証トークンを含める必要があります。例：curl -H "Authorization: Bearer Atza|auth_token"
https://videocentral.amazon.com/apis/v1/accounts
https://videocentral.amazon.com/apis/v1/accounts
リクエストヘッダーにトークンが含まれていないか、トークンが期限切れの場合、APIは不正な例外を返します。
アカウント
このリソースは、ユーザーがアクセスできるSlateアカウントのリストを返します。Slateでは、ウィンドウの右上隅にあるアカウントリストから一連のアカウントにアクセスできます。
リソースにはhttps://videocentral.amazon.com/apis/v1/accountsを介してアクセスできます。以下のコードは応答の例です。
{
"total":3,
"next":"https://videocentral.amazon.com/apis/v1/accounts?offset=2&limit=2",
"data":[
{
"id":"123",
"name":"Account 1"
},
{
"id":"321",
"name":"Account 2"
}
]
}
チャンネルとスタジオ
このリソースは、指定されたレポートグループに応じて、このアカウントで使用可能なチャンネルまたはスタジオのリストを返します。チャンネルまたはスタジオのリストには、Slateのレポートタブにあるチャンネルドロップダウンからアクセスできます。
リソースにはhttps://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}を介してアクセスできます。以下のコードは応答の例です。{
"next":"https://videocentral.amazon.com/apis/v1/accounts/123/channelsPremium?limit=2&offset=2",
"total":3,
"data":[
{
"id":"5fb81476-88ca-370e-b158-7e3d04e0a75e",
"name":"Channel 1",
"territory":"US"
},
{
"id":"756d9819-74ef-32e1-9c65-b2665b7ac867",
"name":"Channel 2",
"territory":"US"
}
]
}
レポートタイプ
このリソースは、特定のチャンネルまたはスタジオで使用可能なレポートタイプのリストを返します。レポートタイプは、Slateのレポートタブで使用できます。
リソースにはhttps://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypesを介してアクセスできます。以下のコードは応答の例です。{
"next":"https://videocentral.amazon.com/apis/v1/accounts/123/channelsPremium/5fb81476-88ca-370e-b158-7e3d04e0a75e/reportTypes?limit=2&offset=2",
"total":10,
"data":[
{
"name":"Content Usage",
"cadence":"Weekly",
"id":"amzn1.vcpa.arcs.insight.8ff7afff-2099-47fd-a58c-fc8de96ffff"
},
{
"name":"Content Usage",
"cadence":"Monthly",
"reportTypeId":"amzn1.vcpa.arcs.insight.3d1a7d87-a21a-444b-b887-49db54c5ffff"
}
]
}
レポート
このリソースは、特定のレポートタイプで使用可能なレポートのリストを返します。レポートは、レポートタイプに対応する「レポート」ドロップダウンリストで使用できます。
リソースにはhttps://videocentral.amazon.com/apis/v1/accounts/{account_id}/{reports_group_id}/{channel/studio_id}/reportTypes/{report_type_id}/reportsを介してアクセスできます。以下のコードは応答の例です。{
"total":2,
"next":"https://videocentral.amazon.com/apis/v1/accounts/123/channelsPremium/123/reportType/123?offset=2&limit=2",
"data":[
{
"numRows":20,
"downloadUrl":"https://packaged-report-v2-prod.s3.us-east-1.amazonaws.com/...",
"reportDateBegin":"2019-01-01",
"reportDateEnd":"2019-01-07",
"modifiedDate":"2020-09-02T21:09:16.045Z",
"name": "Sales",
"cadence": "Daily"
},
{
"numRows":20,
"downloadUrl":"https://packaged-report-v2-prod.s3.us-east-1.amazonaws.com/",
"reportDateBegin":"2019-01-07",
"reportDateEnd":"2019-01-14",
"modifiedDate":"2020-09-02T21:09:16.045Z",
"name": "Sales",
"cadence": "Daily"
}
]
}
さらに、リソースでは、特定のデータ範囲のレポートを検索およびフィルタリングするためのパラメーターを受け入れます。以下の表は、サポートされているリクエストパラメーターの概要です。
reportDateBeginGte |
開始日が指定日またはそれ以降のレポートのみを返します |
reportDateBeginLt |
開始日が指定日より前のレポートのみを返します |
ModifiedDateGte |
指定日以降に生成されたレポートのみを返します。このパラメーターを使用すると、データの品質問題が発生した場合に再生成されたレポートを検出できます。 |
