開発者ガイドの概要

Amazon Ads APIの概要

レポートに予算ルールの値を含める

APIを使用してレポートを作成するには、レポートのフィールドを指定します。ルールベースの予算の指標は、キャンペーンのレポートタイプでのみ使用できます。ルールベースの予算の指標をレポートに追加するには、レポートリクエストで次の指標を指定します。

指標 説明
campaignRuleBasedBudget ルールベースの予算の値。
applicableBudgetRuleId アクティブなルールのID。
applicableBudgetRuleName アクティブなルールの名前。

広告タイプに応じて次のエンドポイントを使用することで、レポートをリクエストできます。

広告タイプ レポートリクエストエンドポイント
スポンサープロダクト広告 POST /reporting/reports
スポンサーブランド広告 POST /v2/hsa/campaigns/report
スポンサーディスプレイ広告 POST /sd/{recordType}/report

レポートリクエストの例 スポンサーブランド広告

ルールベースの予算の指標をすべて含むレポートを作成するには：

次のリクエスト本文を渡してPOST /v2/hsa/campaigns/report操作を使用します。

{
    "reportDate":"20200930",
    "metrics":"campaignBudget,campaignRuleBasedBudget,applicableBudgetRuleId,applicableBudgetRuleName"`
}

次のようなレスポンスが返されます。

[
    {
        //For this campaign, there is no active budget rule or rule based budget is not enforced
        "campaignBudget": 100,
        "campaignId": 144375700196005800
    },
    {
        "campaignBudget": 100,
        "applicableBudgetRuleId": "d9c1d0c5-d686-4d0f-9161-10a0c1a288ff",
        "campaignId": 123456789012345,
        "applicableBudgetRuleName": "SAMPLE_BUDGET_RULE",
        "campaignRuleBasedBudget": 112
    }
]
Amazon Advertising logo