开发人员指南概述

亚马逊广告 API 概览

查看采用了预算规则的广告活动的每日预算的历史更改

您可以使用预算规则历史记录资源来获取规则预算的历史值。在请求资源时,您可以指定规则预算更改的时间范围。每种广告类型都有单独的接口。

广告类型 接口
商品推广 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