开发人员指南概述

亚马逊广告 API 概览

测试账户的授权

在亚马逊广告 API 中,授权是通过 Login with Amazon 的 OAuth 2.0 调用流程完成的。要访问标准广告账户的数据和服务,API 请求中必须包括已批准的 Login with Amazon 应用程序的客户端标识符,以及表示来自亚马逊用户账户的权限的访问令牌,该访问令牌表示对 advertising::campaign_management 权限范围内的数据和服务的访问权限。

创建测试账户需要额外的 advertising::test:create_account 权限范围。任何获得使用亚马逊广告 API 批准的 Login with Amazon 客户端应用程序都可以请求此权限范围。

警告

亚马逊建议不要为现有用户账户请求此权限范围,而是只通过专门用于测试的亚马逊用户账户进行请求,如下所述。管理现有广告账户的用户账户在 API 中无法创建测试账户。

前提条件

访问测试账户 API 需要满足以下先决条件:

  1. **已获准访问亚马逊广告 API 的 Login with Amazon 客户端应用程序。**已批准的客户端可以请求 advertising::test:create_account 权限范围。如果您尚未获得 API 访问权限,请从我们的入门概述开始了解。
  2. *一个当前不*管理亚马逊广告账户的亚马逊用户账户。*亚马逊建议为此目的创建一个新的*亚马逊用户账户,需使用一个开发团队可以访问的有效电子邮件地址。记下此账户的登录凭据,并确保该亚马逊账户在您计划使用测试账户的站点中有效。

授权许可

授予测试账户进行授权的过程类似于授权许可中所描述的过程。

授权许可 URL

最简单的方法是通过单个授权许可 URL 并从测试用户账户请求_两个_权限范围。

根据 Login with Amazon 文档的描述,可以通过使用 URL 编码空格字符 (%20) 将多个范围进行拆分,从而在单个授权许可 URL 中请求多个范围。例如:

advertising::test:create_account%20advertising::campaign_management

例如,具有两个权限范围的授权许可 URL(为了方便阅读,拆分为多行)将类似于以下示例:

https://www.amazon.com/ap/oa
    ?client_id=YOUR_LWA_CLIENT_ID
    &scope=advertising::test:create_account%20advertising::campaign_management
    &response_type=code
    &redirect_uri=YOUR_RETURN_URL

YOUR_LWA_CLIENT_IDYOUR_RETURN_URL 替换为您的 Login with Amazon 应用程序的适当值。有关确定这些值并选择适当的地区主机的详细信息,请参阅授权许可

获取访问令牌

在_未_登录任何亚马逊用户账户的浏览器中访问上述确定的 URL。使用上述第 2 条前提条件中描述的账户登录,然后通过 Login with Amazon 用户界面授予权限。

您将被重定向到指定的重定向 URL,并且授权许可代码将作为 code 查询参数附加在后面。请参阅获取授权码

检索到的代码有效期为 5 分钟,并可用于获取访问令牌和刷新令牌,如访问令牌中所述。

使用访问令牌

通过上述方法检索到的访问令牌将授予客户端应用程序以下权限:

注意

也可以针对每个范围单独请求权限,通过重复授权许可和令牌检索过程。有关更多信息,请参阅授权许可授权概述

与亚马逊广告 API 的其他访问令牌一样,访问令牌在 60 分钟后过期。可以根据需要生成新的访问令牌,有关方法请参阅使用刷新令牌

要开始使用,请参阅创建测试账户