开发人员指南概述

亚马逊广告 API 概览

基于时间表的规则

基于时间表的规则让您能够在某个日期范围内按一定的百分比增加广告活动的预算。此日期范围可基于即将发生的活动,也可以是自定义日期范围。

基于时间表的预算规则使用以下参数创建:

  1. 规则类型:schedule
  2. 日期范围:选择建议的活动标识符之一,例如 Black Friday(黑色星期五),或通过指定规则有效时间段的开始和结束日期来选择自定义日期范围。您可从建议的 API 中检索建议的活动标识符。
  3. 循环周期:选择规则评估频率。
  1. 增加预算幅度:一个百分比值,按照这个百分比增加每日预算。对于建议的活动,提供的建议值是一个可应用于预算规则的百分比。

场景

针对自定义日期范围增加预算

在此场景中,您希望在 11 月 21 日至 11 月 30 日期间每天将广告活动的预算增加 20%。在此示例中,您将为自定义日期范围创建预算规则,该规则将使预算每天增加 20%。

为此,需要调用规则创建 API,将 recurrence 设置为 DAILY,将 dateRange 设置为自定义日期范围,其开始日期设置为 11 月 21 日,结束日期设置为 11 月 30 日。该响应包含一个规则标识符,您将使用该标识符调用规则关联 API。

示例: 商品推广

  1. 使用 POST /sp/budgetRules 创建预算规则。

请求体(request body)示例:

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

预期的 HTTP 状态码: 207

响应体(response body):

{
    "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"
        }
    ]
}

为建议的活动增加预算

注意

建议的活动仅可用于商品推广和品牌推广。

为建议的活动创建规则包括三个步骤:

  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 中创建的预算规则与广告活动相关联。