開発者ガイドの概要

Amazon Ads APIの概要

スケジュールベースのルール

スケジュールベースのルールを使用すると、特定の期間にキャンペーン予算を一定の割合で増やすことができます。この期間は、今後のイベントに基づいて設定することも、カスタム期間にすることもできます。

スケジュールベースの予算ルールは、次のパラメーターを使用して作成されます。

  1. ルールタイプ：schedule
  2. 期間：ブラックフライデーなどの推奨イベント識別子を選択するか、ルールの有効期間の開始日と終了日を指定してカスタム期間を選択します。推奨イベント識別子は、推奨APIから取得できます。
  3. 繰り返し：ルールの評価頻度を選択します。
  1. 予算の増額：1日の予算を増やす割合の金額です。推奨イベントでは、予算ルールに適用できる割合が推奨されます。

シナリオ

カスタム期間の予算の増額

このシナリオでは、11月21日から11月30日までのキャンペーンの予算を1日あたり20%増やしたいとします。この例では、カスタム期間の予算ルールを作成して、予算を毎日20%増やします。

これを実現するには、recurrenceをDAILYに、dateRangeを開始日が11月21日、終了日が11月30日のカスタムに設定して、ルール作成APIを呼び出します。レスポンスには、ルール関連付けAPIを呼び出すために使用するルールIDが含まれています。

例： スポンサープロダクト広告

  1. POST /SP/budgetRulesを使用して予算ルールを作成します。

リクエストボディの例：

{
  "budgetRulesDetails": [
    {
      "name": "SAMPLE_BUDGET_RULE_DAILY",
      "ruleType": "SCHEDULE",
      "duration": {
        "dateRangeTypeRuleDuration": {
          "startDate": "20201121",
          "endDate": "20201130"
        }
      },
      "recurrence": {
        "type": "DAILY"
      },
      "budgetIncreaseBy": {
        "type": "PERCENT",
        "value": 20
      }
    }
  ]
}

予想されるHTTPステータスコード： 207

レスポンスボディ：

{
    "responses": [
        {
            "code": "Ok",
            "details": "Budget rule created",
            "ruleId": "5bc531de-f000-44cf-8a86-54189bcdd380"
        }
    ]
}
  1. POST /sp/campaigns/{campaignId}/budgetRulesを使用して、予算ルールをキャンペーンに関連付けます。

リクエストボディの例：

{
    "budgetRuleIds": ["5bc531de-f000-44cf-8a86-54189bcdd380"]
}

予想されるHTTPステータスコード： 207

レスポンスボディの例：

{
    "responses": [
        {
            "code": "Ok",
            "details": "Budget rule associated",
            "ruleId": "5bc531de-f000-44cf-8a86-54189bcdd380"
        }
    ]
}

推奨イベントの予算の増額

注

推奨イベントは、スポンサープロダクト広告とスポンサーブランド広告でのみ使用できます。

推奨イベントのルールは、次の3つの手順で作成します。

  1. 予算ルールイベント推奨APIを呼び出して、イベントのリスト（スポンサーブランド広告エンドポイントとスポンサープロダクト広告エンドポイント）を受け取ります。各イベントの期間と、予算を増やす推奨割合を含めます。日付が発表される前にリストに表示されているイベントの場合、ルール作成中は開始日と終了日は空になります。これらのルールは、後で日付が発表されたときに自動的に更新されます。
  2. 予算ルールを作成します。
  3. 手順2で作成した予算ルールをキャンペーンに関連付けます。

例： スポンサーブランド広告

  1. 予算ルールイベント推奨API（POST /sb/campaigns/budgetRules/recommendations）を呼び出します。

リクエストボディの例：

{
    "campaignId": "148864597212176"
}

レスポンスの例：

{
  "recommendedBudgetRuleEvents": [
    {
      "eventId": "55583b89-b236-4ccb-ad86-e72f23691eef",
      "eventName": "Halloween",
      "startDate": "20201027",
      "endDate": "20201031",
      "suggestedBudgetIncreasePercent": 20
    }
  ]
}
  1. POST /sb/budgetRulesを使用して予算ルールを作成します。

リクエストボディの例：

{
  "budgetRulesDetails": [
    {
      "name": "SAMPLE_BUDGET_RULE_RECOMMENDED_EVENT",
      "ruleType": "SCHEDULE",
      "duration": {
        "eventTypeRuleDuration": {
          "eventId": "69ce6478-5215-4bd3-8de0-a8eb28ae69a7"
        }
      },
      "recurrence": {
        "type": "DAILY"
      },
      "budgetIncreaseBy": {
        "type": "PERCENT",
        "value": 20
      }
    }
  ]
}

予想されるHTTPステータスコード： 207

レスポンスボディの例：

{
    "responses": [
        {
            "code": "Ok",
            "details": "Budget rule created",
            "ruleId": "5bc531de-f000-44cf-8a86-54189bcdd380"
        }
    ]
}
  1. POST /sb/campaigns/{campaignId}/budgetRulesを使用して、手順2で作成した予算ルールをキャンペーンに関連付けます。

終了日を設定しない金曜日、土曜日、日曜日の予算の増額

このルールは、繰り返しを毎週、曜日を金曜日、土曜日、日曜日に設定してルール作成APIを呼び出すことで設定できます。

例： スポンサーディスプレイ広告

  1. POST /sd/budgetRulesを呼び出してルールを設定します。

リクエストボディの例：

{
  "budgetRulesDetails": [
    {
      "name": "SAMPLE_BUDGET_RULE_WEEKLY",
      "ruleType": "SCHEDULE",
      "duration": {
        "dateRangeTypeRuleDuration": {
          "startDate": "20200901"
        }
      },
      "recurrence": {
        "type": "weekly",
        "daysOfWeek": [
          "FRIDAY",
          "SATURDAY",
          "SUNDAY"
        ]
      },
      "budgetIncreaseBy": {
        "type": "PERCENT",
        "value": 20
      }
    }
  ]
}

予想されるHTTPステータスコード： 207

レスポンスボディの例：

{
    "responses": [
        {
            "code": "Ok",
            "details": "Budget rule created",
            "ruleId": "5bc531de-f000-44cf-8a86-54189bcdd380"
        }
    ]
}
  1. POST /sd/campaigns/{campaignId}/budgetRulesを使用して、手順1で作成した予算ルールをキャンペーンに関連付けます。
Amazon Advertising logo