このトピックでは、SlateアカウントにリンクされているRAMP/AcadiaアカウントIDにおける財務諸表を取得するために、財務諸表APIを認証して使用する方法について、手順を追って説明します。これらの手順に従ってもまだ不明な点がある場合は、ベンダーマネージャーに連絡するか、お問い合わせサポートからチケットを送信してください。
前提条件
これらのステップを実行するには、Prime Video Slateアカウントが必要です。
- まだSlateアカウントをお持ちでない場合は、slate.amazon.comにアクセスしてアカウントを作成してください。その後、このページに戻り、ステップ1から開始してください。
または - APIを通して既存のチャンネルとTVODのレガシーレポートにすでにオンボーディングされている場合は、ステップ3にスキップしてください。
ステップ2: レポーティングAPIを呼び出す権限を取得する
アプリケーションを財務諸表APIと統合するには、まずアナリティクスAPIスイートにオンボーディングする必要があります。詳細なオンボーディング手順については、APIオンボーディングページをご覧ください。
APIの使い方について詳しくは、Prime Video APIをご覧ください。
ステップ4: 正しいAPI URLをビルドする
一般的なレポーティングAPI URLは以下の形式で、括弧内の内容{}はパートナーによって異なります:https://videocentral.amazon.com/apis/v1/accounts/{account_id}/financialStatement/{report_identifier}/reportTypes/{report_type_id}/reports
各プレースホルダーのパスパラメーターは以下のように定義されます。
- account_id: SlateアカウントにリンクされているRAMP/AcadiaアカウントID。このIDについては、パートナーマネージャーにお問い合わせください。既存のレガシーレポートユーザーの場合、これは変更されないままとなります。
report_identifier: これはパートナーマネージャーかベンダーマネージャーにより設定されます。レポートがアカウントで利用できるリストを取得するには、API URL https://videocentral.amazon.com/apis/v1/accounts/{account_id}/financialStatementを呼び出してください
これにより、アクセスできるすべてのレポート識別子が表示されます。
report_type_id: これは固定値です。レポートを取得するには、次のオプションのいずれかを使用してください
- チャンネル用: amzn1.vcpa.arcs.insight.286fd5d9-aeb3-4eb0-99a1-959225160a01
- TVOD用: amzn1.vcpa.arcs.insight.33ee837f-af47-40d6-8c2c-798eba24fac8
- SVOD固定料金用: amzn1.vcpa.arcs.insight.10a37dcd-8912-4173-b428-600e237f7508
- AVOD、SVOD CPH、リニア用: amzn1.vcpa.arcs.insight.f9efc58e-51dd-4e2c-a864-aae7e32a7f73
最終的なAPIレスポンス
正しいAPI URLを取得し、パートナーマネージャーが適切なレポートを表示すると、このようなAPIレスポンスが得られます。(次のスクリーンショットは、テストアカウントのAPI URLからのものです。)
レポートの取得に使用するAPI URLは以下のものとなります:
https://videocentral.amazon.com/apis/v1/accounts/{partner’s acadia account ID}/financialStatement/{report_identifier}/reportTypes/{report_type_id}/reports
APIレスポンスに表示されるdownloadUrlは、レポートをダウンロードするための署名付きURLです。APIレスポンスに表示されるmodifiedDateは、特定のレポートにおいてデータがリフレッシュされた時間です。
API URLを使用すると、Slateアカウントで利用可能なすべてのレポートを取得できます。特定の月を確認する場合は、APIリクエストパラメーターのreportDateBeginGteとreportDateBeginLtを使用して時間範囲を指定できます。
例えば、2024年10月を指定してレポートを取得するには、reportDateBeginGteを2024-10-01に設定し、reportDateBeginLtを2024-11-01に設定してください。
他のレポーティングAPIの詳細については、Prime Video APIを参照してください