开发人员指南概述

亚马逊广告 API 概览

第 1 步： 创建授权许可

入门操作：概述 | [1.创建权限授予]（guides/get-started/create-authorization-grant）| [2.生成访问令牌]（guides/get-started/retrieve-access-token）| [3.检索配置文件]（guides/get-started/retrieve-profiles）

正如“入门”概览中所述，经批准的客户端应用程序可代表有权访问亚马逊广告账户的亚马逊用户账户调用亚马逊广告 API。

客户端应用程序和用户账户之间的关系由 Login with Amazon (LwA) 管理。用户账户必须通过 LwA 授权码授予（Authorization Code Grant）流程向客户端应用程序明确授予权限才能生成授权码，如下所述。

请求及授予访问与用户账户关联的广告数据和服务的授权有两种情况：

无论哪种情况，您都将创建一个授权 URL。

创建授权 URL

要检索授权码，请创建一个授权 URL，让用户账户能够向您的客户端应用程序授予权限。此过程包含三个步骤：

允许返回 URL

使用您的亚马逊开发人员账户登录亚马逊开发人员平台，然后选择顶部菜单中的 Login with Amazon。

选择您用于申请 API 访问权限的安全配置文件，将鼠标移至屏幕右侧管理下的“齿轮”图标，然后从菜单中选择 Web 设置。

Login with Amazon 平台的屏幕截图

在“Web 设置”面板中，点击编辑。在允许的返回 URL（Allowed Return URL）字段中添加有效地址，然后点击保存。

什么是允许的返回 URL？

您添加到“允许的返回 URL”列表中的任何 URL 都可用作下文“确定所需查询参数的值”中的 redirect_uri 参数。广告主向您的 LwA 客户端授予授权后，广告主将被重定向到指定的 URL，并以查询参数的形式追加授权码。这些方法中的任何一种都可能最适合您的适用场景：

  1. ****寻求第三方授权的合作伙伴最终可能希望创建自定义返回 URL 或将 LwA 与自己的应用程序结合使用。如果您希望进一步了解此方法，请参阅 Login with Amazon 文档。
  2. 直接广告主可以使用任何有效的 URL，例如 https://amazon.com，然后按如下所述手动检索授权码。
本次演练的其余部分遵循第二种方法。

确定您所在地区的 URL 前缀

Login with Amazon 针对每个地区应用了不同的授权 URL 前缀。从下表中选择您所在地区的 URL。

地区 URL 前缀
北美地区（NA） https://www.amazon.com/ap/oa
欧洲地区（EU） https://eu.account.amazon.com/ap/oa
远东地区（FE） https://apac.account.amazon.com/ap/oa

注意

从这些 URL 中获取的授权码可用于访问任何地区的广告 API。

警告

如果此授权是针对**数据提供程序 API **的，请记住您为每个地区创建了单独的 DSP 账户。您需要重复此过程三次，即对上述每个地区重复一次操作。

确定所需查询参数的值

授权 URL 具有以下查询参数：

参数 说明
client_id 与您的 Login with Amazon 客户端应用程序关联的客户端 ID。如果您希望进一步了解查找客户端 ID，请参阅创建 Login with Amazon 应用程序。
范围 指的是 OAuth 2.0 权限范围，用于限制应用程序对广告主账户的访问权限。

对于 DSP、品牌推广、展示型推广、商品推广和亚马逊引流洞察 API，请将范围设置为 advertising::campaign_management。对于数据提供程序 API，请将范围设置为 advertising::audiences。
response_type 指的是响应的类型。请始终设置为 code。
redirect_uri 指的是上述设置的 Login with Amazon 安全配置文件的允许的返回 URL 字段中的值。

注意

如果您希望进一步了解可选参数，请参阅权限授予。

要在北美（NA）地区生成授权码，请将以下 URL 中的 YOUR_LWA_CLIENT_ID 和 YOUR_RETURN_URL 替换为您需要的值：

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

注意

在 2020 年 10 月之前获准访问 API 的 LwA 客户端可能需要将范围设置为 cpc_advertising:campaign_management。

授予您自己访问亚马逊广告数据的权限

有关获取第三方数据访问权限的说明，请参阅下方的“获取第三方亚马逊广告数据访问权限”。

如果您要授予自己访问广告数据和服务的权限，请按以下步骤操作：

  1. 将以上确定的授权 URL 粘贴到浏览器的地址栏中。导航至该 URL。

  2. 使用具有亚马逊广告账户访问权限的亚马逊用户账户（您希望通过 API 管理这些账户）进行登录。此账户可能与您创建 LwA 客户端时使用的亚马逊开发人员账户不同。

  3. 您将被重定向到同意书页面，其中列出了授权许可流程中包含的具体数据和服务。要授予访问权限，请选择允许。

  4. 您将被重定向到之前指定的 redirect_uri，并在该 URL 中追加查询参数。从浏览器的地址栏中复制地址，并记下代码参数的值（以下示例中的 xxxx）：

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

要继续操作，请参阅下方的“后续步骤”。

获取第三方的亚马逊广告数据的访问权限

如果您要请求第三方授予您对其广告数据和服务的访问权限，请按以下步骤操作：

  1. 将以上确定的授权 URL 发送至第三方，并说明如何将 URL 粘贴到浏览器的地址栏中并导航至 URL。

  2. 告知第三方使用有权访问他们希望授予权限的亚马逊广告账户的亚马逊用户账户进行登录。

  3. 第三方将被重定向到同意书页面，其中列出了授予授权流程中包含的具体数据和服务。如果第三方同意与您共享这些数据和服务，则告知他们选择允许。

  4. 他们将被重定向到之前指定的 redirect_uri，并在该 URL 中追加查询参数。指示第三方将此 URL 发送给您。

请注意代码参数的值（以下示例中的 xxxx）：

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

后续步骤

重定向 URL 中的代码参数是授权码，您现在可以在入门指南流程的下一步中使用该代码： 检索访问权限并刷新令牌。

警告

授权码将在 5 分钟后失效。重复上述步骤可以生成新的代码。

技术支持

如果您在连接亚马逊广告 API 时遇到问题，请访问我们的技术支持页面以获取相关信息。

Amazon Advertising logo