スナップショットに予算ルールの値を含める

スナップショットを使用すると、キャンペーンとキーワードのレコードを非同期で一括取得できます。

次の表に、スナップショットをリクエストするために使用するエンドポイントを広告タイプ別に示します。

広告タイプ	スナップショットリクエストのエンドポイント
スポンサーブランド広告	POST /v2/hsa/{recordType}/snapshot
スポンサープロダクト広告	POST /v2/sp/{recordType}/snapshot
スポンサーディスプレイ広告	POST /v2/sd/{recordType}/snapshot

すでにスナップショットAPIを使用してデータを一括取得している場合は、リクエストを変更する必要はありません。キャンペーンの予算ルールを作成済みで、現時点でルールベースの予算が適用されている場合には、スナップショットのレスポンスにruleBasedBudgetオブジェクトが含まれます。

ruleBasedBudgetオブジェクトには、次の属性があります。

value：ルールに基づく予算の値
applicableRuleId：有効なルールのID
applicableRuleName：有効なルール名
isProcessing：ルールの評価が進行中の場合には、trueに設定されます。評価が完了し、ルール予算の値が更新されたら、falseに設定されます。

2023年2月現在、予算ルールが適用されていることを示す指標としてruleBasedBudgetオブジェクトの存在を利用し、GET /sb/campaigns/{campaignId}/budgetRulesを使用して、キャンペーンの予算ルールの履歴をすべて取得することができます。ステータスがACTIVEの予算ルールは、キャンペーンで有効に機能しています。

警告

2023年2月現在、複数のルールが同時に有効化されているために、applicableRuleIdの値が完全でないことがあります（ルール評価の詳細をご覧ください）。そのため、キャンペーンで有効なルールを確認する場合には、GET /sb/campaigns/{campaignId}/budgetRulesを使用してください。

例：

現在適用されているルールベースの予算：

{
    "campaignId": 12345678901234,
    "name": "Sample Budget Rule Campaign",
    "budget": 100,
    "budgetType": "daily",
    "ruleBasedBudget": {
        "value": 110,
        "applicableRuleId": "e887669c-0f22-42fa-85ab-2ba96ea8190c",
        "applicableRuleName": "SAMPLE_BUDGET_RULE",
        "isProcessing": false
    },
    "startDate": "20200915",
    "state": "enabled",
    "bidOptimization": "false"
}

ルールベースの予算が現在適用されていないキャンペーン、または有効な予算ルールが存在しないキャンペーン：

{
     "campaignId": 12345678901234,
    "name": "Sample Budget Rule Campaign",
    "budget": 100,
    "budgetType": "daily",
    "startDate": "20200915",
    "state": "enabled",
    "bidOptimization": "false"
}

開発者ガイドの概要

Amazon Ads APIの概要

スナップショットに予算ルールの値を含める

警告