予算ルールが設定されているキャンペーンにおける「1日の予算」の変更内容を表示する

サポートされている各広告タイプのキャンペーンリソースのリストを使用して、予算ルールが設定されているキャンペーンの予算を表示できます。このプロセスは、スポンサーブランド広告、スポンサーディスプレイ広告、スポンサープロダクトの広告バージョン2では同じですが、スポンサープロダクト広告のバージョン3では異なります。

スポンサープロダクト広告のバージョン3

バージョン3では、キャンペーンの予算が予算ルールの影響を受けている場合、POST /sp/campaigns/listから返されるキャンペーンのbudgetオブジェクトに、「effectiveBudget」フィールドが含まれています。

effectiveBudgetを、予算ルールが適用されていることを示す指標として使用し、そのキャンペーンの完全な予算ルール履歴をGET /sp/campaigns/{campaignId}/budgetRulesで取得することができます。ステータスが「ACTIVE」の予算ルールが、キャンペーンで有効に機能しています。

スポンサーブランド広告、スポンサーディスプレイ広告、スポンサープロダクト広告のバージョン2

予算ルールが設定されているキャンペーンの予算は、その広告タイプに関連付けられているキャンペーンリソースのリストを使用して確認できます。

広告タイプ	キャンペーンの一覧表示エンドポイント
スポンサープロダクト広告（V2）	GET v2/sp/campaigns
スポンサーブランド広告	POST /sb/v4/campaigns/list
スポンサーディスプレイ広告	GET /sd/campaigns

レスポンスにruleBasedBudgetが存在する場合、予算ルールが適用されていることを示します。その後、その広告タイプに該当するGET /campaigns/{campaignId}/budgetRulesエンドポイントを使用して、そのキャンペーンの予算ルール履歴をすべて取得できます。ステータスが「ACTIVE」の予算ルールが、キャンペーンで有効に機能しています。

広告タイプ	GET budget rulesエンドポイント
スポンサープロダクト広告	GET /sp/campaigns/{campaignId}/budgetRules
スポンサーブランド広告	GET /sb/campaigns/{campaignId}/budgetRules
スポンサーディスプレイ広告	GET /sd/campaigns/{campaignId}/budgetRules

[要確認]2023年2月現在、複数のルールが同時に有効となっているために、applicableRuleIdが完全でないことがあります（ルール評価の詳細をご覧ください）。そのため、キャンペーンでアクティブなルールを確認する場合には、該当するGET /campaigns/{campaignId}/budgetRulesエンドポイントを使用してください。

ルール評価の進捗状況

ruleBasedBudgetオブジェクトには「IsProcessing」フィールドも含まれています。このフィールドが「true」に設定されている場合は、ルール評価が進行されています。評価が完了すると、ルール予算の値が更新され、IsProcessing が「false」に設定されます。

例

こちらは、予算ルールが適用されたスポンサーブランド広告キャンペーンの例です。

GET /sb/campaigns/{campaignId}

ルール評価が進行中の場合は、以下のようなレスポンスが返されます：

シナリオ2： 予算ルール評価が進行中の場合
{
            "campaignId": 148864597212176,
            "name": "Sample Budget Rule Campaign",
            "campaignType": "sponsoredProducts",
            "targetingType": "manual",
            "premiumBidAdjustment": false,
            "dailyBudget": 10.0,
            "ruleBasedBudget": {
                "isProcessing": true
            },
            "startDate": "20181010",
            "state": "enabled",
            "bidding": {
                "adjustments": []
            }
}

ルール評価が完了すると、以下のようなレスポンスが返されます：

{
            "campaignId": 148864597212176,
"name": "Sample Budget Rule Campaign",
            "campaignType": "sponsoredProducts",
            "targetingType": "manual",
            "premiumBidAdjustment": false,
            "dailyBudget": 10.0,
            "ruleBasedBudget": {
                "value": 12.0,
                "applicableRuleId": "5bc531de-f000-44cf-8a86-54189bcdd380",
                "applicableRuleName": "SAMPLE_BUDGET_RULE",
                "isProcessing": false
        },
        "startDate": "20181010",
        "state": "enabled",
        "bidding": {
           "adjustments": []
            }
}