开发人员指南概述

亚马逊广告 API 概览

快速入门指南： 使用亚马逊广告 API Postman 集合

亚马逊广告 API Postman 集合包含了一些脚本，用于简化调用 API 时的身份验证和授权凭据管理，同时提供了预先构建的请求，用于演示 API 的常见用法。

作为我们入门指南的替代方案，初次调用者可能会发现 Postman 对于理解 API 很有帮助。

下面的快速设置提供了配置 Postman 集合以向 API 发送请求的分布说明。

前提条件

要完成本指南，您需要：

提示：

本文档中使用的 Postman 用户界面术语与 Postman 保持一致。有关更多信息和可视化辅助，请参阅 Postman 的界面文档。

快速设置

导入集合和环境文件

  1. 通过 GitHub 下载 Postman 环境文件 和集合文件。
  2. 将这两个文件导入 Postman 。导入后进行验证：
    • 在左侧边栏中选择 Collections 图标，可以找到**亚马逊广告 API **集合。
    • 在左侧边栏中选择 Environments 图标，可以找到亚马逊广告 API 环境。
  3. 从 Environments 选择器中选择 Amazon Ads API Environment 以激活该环境。

配置环境

  1. 在左侧边栏中，选择 Environments，然后再选择 Amazon Ads API Environment。

  2. 手动设置以下变量的当前值：

    变量 描述
    client_id 已获准使用 API 的 Login with Amazon 客户端应用程序的客户端编号。
    client_secret 已获准使用 API 的 Login with Amazon 客户端应用程序的客户端密钥。
    redirect_uri Login with Amazon 应用程序的“允许的返回 URL”配置中包含的 URL。

    在环境中，默认设置为 https://amazon.com。您仍然需要[在 Login with Amazon 中启用此 URL](../../guides/get-started/create-authorization-grant.html) 或修改此变量以反映另一个允许的 URL。

    [请注意]默认环境配置为访问 API 的北美主机。要进行其他地区的 API 访问，参见地区。

  3. 保存对环境的更改。

生成授权授予代码

  1. 在 Postman 左侧栏中，前往 Collections > Amazon Ads API。

  2. 在集合中选择Auth 文件夹，然后找到 GET Auth grant login 请求。

  3. 在 Postman 底部打开Console。

  4. 发送该请求。此操作会测试 Postman 预览窗口中的 URL，并将适当的 URL 记录到 Postman 控制台中。

  5. 从控制台中复制授权授予 URL，使用用于管理亚马逊广告账户的亚马逊用户账户在 Web 浏览器中访问该 URL 并进行登录。

    警告

    在访问授权 URL 之前，请确保已从其他亚马逊用户账户注销。

  6. 您将被引导至您在环境文件中设置的 redirect_uri。授权授予代码将作为 code 查询参数附加到此 URL。

在浏览器的 URL 栏中，地址应类似于以下内容，其中 XXXXX 是授权授予代码：

https://amazon.com/?code=XXXXX&scope=advertising%3A%3Acampaign_management

请记下此代码，以备下一步使用。授权代码表示用户账户授权您的客户端应用程序访问该账户的广告数据和服务的权限。

[请注意] 授权码将在 5 分钟后过期。可以通过重复授权授予过程生成新的代码。

获取访问令牌和刷新令牌

  1. 从集合的 Auth 文件夹中，选择 POST Access token from auth grant 请求。
  2. 在该请求的 Body 部分，找到 code 参数，并输入前一步中获取的代码。
  3. 发送该请求。

成功的请求将在您的环境中设置 access_token 和 refresh_token 变量。

提示：令牌到期

访问令牌将在 60 分钟后过期。刷新令牌不会过期。

对于后续对 API 的请求，亚马逊广告 API Postman 集合中的脚本会根据需要使用刷新令牌自动生成新的访问令牌。

获取配置文件标识符

  1. 在集合中选择 Profiles 文件夹。
  2. 选择 GET Profiles 请求并发送该请求。

该请求的响应是一个_配置文件_列表，每个配置文件分别表示用户账户在特定站点中的亚马逊广告账户。

默认情况下，集合中的脚本将 profileId 变量设置为响应中返回的_第一个_配置文件。该值将在后续调用中使用。有关配置文件的详细信息，请参阅配置文件。

后续步骤

您的 Postman 环境现在具备了向亚马逊广告 API 发送其他请求所需的凭据：

Postman 集合已配置为在后续请求的消息头中包含这些值。

要测试对 API 的典型首次调用，请参阅 进行首次调用。

[[主题：技术支持]] 如果您在连接到亚马逊广告 API 方面遇到困难，请访问我们的技术支持页面 获取信息。

如果您认为问题与此文档或 Postman 集合本身有关，您可以在我们的 GitHub 存储库 中提出问题。

可选更改

地区

提供的环境已配置为调用亚马逊广告 API 的北美主机。要访问欧洲或亚洲的广告数据和服务，请将环境中的 api_url、auth_grant_url 和 token_url 变量更改为适当的地区或主机。

地区 api_url auth_grant_url token_url
北美 https://advertising-api.amazon.com https://www.amazon.com/ap/oa https://api.amazon.com/auth/o2/token
欧洲 https://advertising-api-eu.amazon.com https://eu.account.amazon.com/ap/oa https://api.amazon.co.uk/auth/o2/token
远东 https://advertising-api-fe.amazon.com https://apac.account.amazon.com/ap/oa https://api.amazon.co.jp/auth/o2/token

有关每个地区的站点列表，请参阅 API 接口。

Amazon Advertising logo