Postman 入门操作
Postman 是一款允许开发人员使用用户界面进行 API 调用的工具。Postman 还可以存储变量并执行基本自动操作,简化 API 测试。亚马逊广告提供了一个 Postman 集合,其中包含一些我们最常用的接口,使开发人员可以轻松测试 API。Postman 还可以自动生成多种编程语言的代码示例。
本教程介绍了如何设置亚马逊广告 API Postman 集合。
前提条件
确定您希望使用的 Postman 版本。如果您没有 Postman 账户,可以下载桌面应用程序。您还可以创建一个免费账户 并使用 Web 应用程序。
本教程假设您已经完成了 API 的入门流程 并且已经生成了访问令牌和刷新令牌。
教程
文件导入和环境设置
-
- 在 Collections 选项卡中,可以找到**亚马逊广告 API **集合。
- 在 Environments 选项卡中,可以找到亚马逊广告 API 环境。
在 Environments 选项卡中,选择 Amazon Ads API Environment。
将您的身份验证凭据添加到环境变量中。将以下变量的 Current Value 列中输入您的凭据:
变量 描述 client_id
与您的“Login with Amazon”应用程序关联的客户端编号。 client_secret
与您的“Login with Amazon”应用程序关联的客户端编号。 refresh_token
用于获取新的访问令牌的刷新令牌。 (可选)更新 URL 前缀。在下载的文件中,
api_url
中填充了北美 URL。如果您正在处理位于北美以外地区的广告账户,请更新api_url
。请参阅 API 概述以获取可用的地理位置 URL。保存对环境变量的更改。
获取新的访问令牌
- 从 Postman 的 Collections 选项卡中,转到亚马逊广告 API 集合。
- 将活动环境变量设置为亚马逊广告 API。
- 打开
POST
Access token from refresh token 接口。将鼠标悬停在{{refresh_token}}
、{{client_id}
和{{client_secret}}
值上,检查它们是否从您的环境变量中提取了正确的值。 - 发送请求。您应该会得到一个
200 OK
响应代码。 - 返回到您的亚马逊广告 API 环境。您应该会看到
access_token
的全新当前值,以及token_expires_at
的当前值中的时间戳。
提示
token_expires_at
用于跟踪令牌的过期时间。默认情况下,每次在集合中进行调用时,Postman 都会检查您的令牌是否已过期。如果令牌已过期,Postman 会自动在调用之前刷新令牌。
获取您的配置文件标识符
- 要使用 API 进行其他调用,您需要一个配置文件标识符。如果您知道您的配置文件标识符,可以直接将其输入到亚马逊广告 API 环境的
profileId
变量中。
提示:不知道您的配置文件标识符?
如果您不知道您的配置文件标识符,请使用 Profiles >
GET
Profiles 接口返回与您的账户关联的配置文件。第一个返回的配置文件会自动添加到您的环境变量中。如果您有多个配置文件标识符,请确保将所需的配置文件标识符复制并粘贴到您的环境变量中。
现在,您的环境变量已具备有效的访问令牌和配置文件标识符,您可以立即开始调用亚马逊广告 API!
后续步骤
浏览以下教程:
提示:刚接触亚马逊广告?
使用 Postman 创建一个测试账户,您可以在不产生广告支出的情况下练习创建广告活动。
当前支持的功能
亚马逊广告 API 的 Postman 集合目前支持以下功能:
- 身份验证
- 搜索广告报告
- 搜索广告快照
- 测试账户
- 账户管理
- Amazon Marketing Stream(测试版)
- 商品推广活动管理(版本 3)
- 产品元数据
注意
对于展示型推广接口,有一个单独的集合可供使用。如果您想测试展示型推广接口,请参考展示型推广 Postman 教程。
环境变量定义
此表格包含环境文件中所有变量的描述。
变量 | 描述 |
---|---|
client_id |
授权的 Login with Amazon 应用程序的客户端编号。 |
client_secret |
授权的 Login with Amazon 应用程序的客户端秘钥。 |
permission_scope |
用于确定账户权限范围。对于一般的API使用,请将默认值保持为 advertising::campaign_management 。 |
redirect_uri |
输入在 Login with Amazon 应用程序的允许的返回 URL 配置中包含的 URL。默认设置为 https://amazon.com ;请在 Login with Amazon 中启用此 URL。 |
access_token |
用于认证您的 API 调用的访问令牌。每个令牌的有效期为 60 分钟。 |
refresh_token |
用于刷新访问令牌的令牌。 |
token_expires_at |
访问令牌过期的时间戳。 |
profileId |
与您的亚马逊广告账户关联的配置文件标识符。 |
auth_grant_url |
用于授权调用的 URL 前缀。 |
token_url |
用于令牌调用的 URL 前缀。 |
api_url |
用于一般 API 调用的 URL 前缀。 |
支持
如果您对 Postman 集合有任何反馈或问题,请在我们的 GitHub 存储库中提出问题。