开发人员指南概述

亚马逊广告 API 概览

首次调用亚马逊广告 API

您可以使用广告 API 来管理广告活动、提取报告数据等。本教程可帮助您了解如何使用相关的 GET 广告活动接口列出所有活跃的搜索广告（商品推广、品牌推广和展示型推广）广告活动。

前提条件

注意

本教程假设您已经完成了广告 API 的入门和开始使用流程。

要完成本教程，请确保您已经具备以下条件：

请求

URL 前缀

调用广告 API 时应使用的前缀基于请求中使用的配置文件的地理位置。

URL 地区和站点
https://advertising-api.amazon.com 北美 (NA)。包括美国、加拿大、墨西哥和巴西站点
https://advertising-api-eu.amazon.com 欧洲 (EU)。包括英国、法国、意大利、西班牙、德国、荷兰、阿联酋、波兰和土耳其站点
https://advertising-api-fe.amazon.com 远东 (FE)。包括日本、澳大利亚和新加坡站点。

标头

对亚马逊广告 API 的大多数调用都需要通用标头：

| 标头 | 必需？ | 描述 | |--------|-------------| | Amazon-Advertising-API-ClientId | 是 | 与 Login with Amazon 应用程序有关的客户端编号 | | Authorization | 是 | 格式为Bearer access_token的有效 API 访问令牌。访问令牌的有效期仅为一小时。 | | Amazon-Advertising-API-Scope | 是 | 亚马逊广告配置文件标识符。 | | Accept | 否 | accept 标头用于指定版本。如果未指定 Accept 标头，则默认为 application/json。 |

请求示例

如果您要复制示例，请确保输入自己的客户端编号、访问令牌和配置文件标识符。

商品推广

完整参考： POST sp/campaigns/list

cURL 
<p>此示例显示了使用北美 URL 前缀的商品推广活动列表请求。</p>

```bash
    curl --location --request POST 'https://advertising-api.amazon.com/sp/campaigns/list' \
    --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxx' \
    --header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
    --header 'Authorization: Bearer xxxxxxxxxxxx' \
    --header 'Accept: application/vnd.spCampaign.v3+json' \
    --header 'Content-Type: application/vnd.spCampaign.v3+json' \
```
Postman
  1. 确保已将亚马逊广告 API Postman 集合和环境文件导入 Postman。如果您尚未完成 Postman 设置，请参阅亚马逊的 Postman 教程。
  2. 在 Postman 中，导航到亚马逊广告 API集合。
  3. 前往 First call 文件夹，打开**POST List SP campaigns** 接口。
  4. 在 Headers 选项卡中，确保您的环境变量已正确填充。
  5. 发送您的请求。

品牌推广

完整参考： POST sb/beta/campaigns/list

cURL 
<p>此示例显示了使用北美 URL 前缀的品牌推广活动列表请求。</p>

```bash
    curl --location --request GET 'https://advertising-api.amazon.com/sb/beta/campaigns/list' \
    --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxx' \
    --header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
    --header 'Authorization: Bearer xxxxxxxxxxxx' \
    --header 'Accept: application/vnd.sbcampaignresource.v4+json'
    --header 'Content-Type: application/vnd.sbcampaignresource.v4+json'
```
Postman
  1. 确保已将亚马逊广告 API Postman 集合和环境文件导入 Postman。如果您尚未完成 Postman 设置，请参阅亚马逊的 Postman 教程。
  2. 在 Postman 中，导航到亚马逊广告 API集合。
  3. 前往 First call 文件夹，打开 POST List SB campaigns 接口。
  4. 在 Headers 选项卡中，确保您的环境变量已正确填充。
  5. 发送您的请求。

展示型推广

完整参考： GET sd/campaigns

cURL 
<p>此示例显示了使用北美 URL 前缀的 GET 展示型推广活动请求。</p>

```bash
    curl --location --request GET 'https://advertising-api.amazon.com/sd/campaigns' \
    --header 'Amazon-Advertising-API-ClientId: amzn1.application-oa2-client.xxxxxxxxxx' \
    --header 'Amazon-Advertising-API-Scope: xxxxxxxxx' \
    --header 'Authorization: Bearer xxxxxxxxxxxx' \
```
Postman
  1. 确保已将亚马逊广告 API Postman 集合和环境文件导入 Postman。如果您尚未完成 Postman 设置，请参阅亚马逊的 Postman 教程。
  2. 在 Postman 中，导航到亚马逊广告 API集合。
  3. 前往 First call 文件夹，打开 GET List SD campaigns 接口。
  4. 在 Headers 选项卡中，确保您的环境变量已正确填充。
  5. 发送您的请求。

响应

对任何 GET 广告活动接口的成功响应都会返回200响应代码。响应体包含广告活动对象构成的一个 JSON 数组。

示例

以下示例响应包含一个展示型推广活动。

[
    {
        "campaignId": 127519806194475,
        "name": "SdTestCampaign-26/01/2022 15:37:31",
        "tactic": "T00020",
        "startDate": "20220126",
        "state": "enabled",
        "costType": "cpc",
        "budget": 100,
        "budgetType": "daily",
        "deliveryProfile": "as_soon_as_possible"
    }
]

收到空白响应

如果您尚未创建任何特定广告类型的广告活动，则会收到200响应，其中包含一个空的 JSON 数组 ([])。要查看您是否有活跃的广告活动，请登录亚马逊广告平台。

提示

如果您是亚马逊广告新手，并且没有任何广告活动，请尝试创建测试账户。拥有测试账户后，您可以练习构建广告活动，而不会影响支出。

后续步骤

您已经了解了亚马逊广告 API 的基本请求和响应结构，现在可以开始研究适合您需求的用例了。

对于具有活跃广告活动的广告主

对于亚马逊广告新手广告主

Amazon Advertising logo