予算ルールが設定されているキャンペーンの1日の予算の履歴変更の表示

予算ルール履歴リソースを使用して、ルール予算の過去の値を取得できます。リソースをリクエストするときに、ルール予算の変更の時間範囲を指定できます。広告タイプごとに個別のエンドポイントがあります。

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

警告

これらのエンドポイントは、2023年8月31日に廃止されます。

注

指定できる最大範囲は90日です。

リクエストレスポンスには、指定したキャンペーンのルール予算変更のリストが含まれます。リクエストレスポンスリストはページ分割されるため、リクエストにページサイズを含め、以前に返されたレスポンスの値を指定したnextTokenを含める必要があります。

例

この例は、スポンサーブランド広告のプロセスを示しています。他の広告タイプでも同じです。

まず、履歴リソースのリストをリクエストします。

GET /sb/campaigns/{campaignId}/budgetRules/budgetHistory?pageSize=1&startDate=20200706&endDate=20200707

レスポンスは次のようになります。

{
    "history": [
    {
      "appliedRule": {
        "ruleDetails": {
          "budgetIncreaseBy": {
            "type": "PERCENT",
            "value": 20.0
          },
          "duration": {
            "dateRangeTypeRuleDuration": {
              "endDate": "20200707",
              "startDate": "20200706"
            }
          },
          "name": "SAMPLE_BUDGET_RULE",
          "performanceMeasureCondition”: {
            "metricName": "ACOS",
            "threshold”: 20.0,
            "comparison Operator”: "LESS_THAN_OR_EQUAL_TO"
          },
          “recurrence” : {
            “type”: “DAILY"
          }
        },
        "ruleType": “PERFORMANCE”: { 
          "ruleId": "10c204e9-ccc2-4ed5-903e-99363dad6851",
          "ruleState": "ACTIVE"
        },
        "dailyBudgetValue": 10.0,
        "executionTime": 1594128659918,
        "ruleBasedBudgetValue": 12.0,
        “performanceMetric”: {
            “metricName”: “ACOS”,
            “value”: 10
        }
    }],
    "nextToken": "tqcN6nsiYnVkZ2V0U3RhcnRUaW1lc3RhbXAiOnsib”
}

このレスポンスで、nextTokenフィールドが空欄ではないことに注意してください。次の履歴リソースセットを返す場合のリクエストは次のようになります。

GET /sb/campaigns/{campaignId}/budgetRules/budgetHistory?pageSize=1&startDate=20200706&endDate=20200707
&nextToken=tqcN6nsiYnVkZ2V0U3RhcnRUaW1lc3RhbXAiOnsib