第 3 步: 获取配置文件标识符
入门操作:概述 | [1.创建权限授予](guides/get-started/create-authorization-grant)| [2.生成访问令牌](guides/get-started/retrieve-access-token)| [3.检索配置文件](guides/get-started/retrieve-profiles)
如“入门操作”概览中所述,调用亚马逊广告 API 需要两个重要的授权凭据:
- 已获得 API 访问批准的 Login with Amazon (LwA) 客户端应用程序的客户端编号。
- 表示客户端有权代表管理亚马逊广告账户的亚马逊用户账户访问资源的访问令牌。
此外,几乎所有对 API 的请求都需要传递一个配置文件标识符,表示用户在_特定_站点中的广告账户。在生成访问令牌后,遵循下面的步骤获取用于 API 请求的配置文件标识符。
访问配置文件资源
为了检索可用的配置文件列表,请向用户账户管理广告账户所在区地区站点的 /v2/profiles
接口发出 GET
请求。
- 有关地区站点主机列表,请参阅 API 接口。
- 有关技术规范,请参阅配置文件 OpenAPI 规范。
例如,对于管理墨西哥站点广告账户的用户账户,应该将请求发送到北美站点的主机:
https://advertising-api.amazon.com/v2/profiles
该请求需要两个必填的标头:
Amazon-Advertising-API-ClientId
: LwA 客户端应用程序的客户端标识符。Authorization
: 加在访问令牌之前的Bearer
字符串。
对于使用 cURL 调用北美站点主机的请求,请替换以下请求中的值:
curl \
-H "Amazon-Advertising-API-ClientId: YOUR_CLIENT_ID"\
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
https://advertising-api.amazon.com/v2/profiles
配置文件响应
成功调用此接口的响应将包括与用户账户在 API 主机的地区站点中的关联配置文件列表。
例如,北美站点主机对于管理一个广告账户(位于墨西哥站点)的用户账户的响应将类似于以下内容:
[
{
"profileId": 888888888,
"countryCode": "MX",
"currencyCode": "MXN",
"timezone": "America/Los_Angeles",
"accountInfo": {
"marketplaceStringId": "A1AM78C64UM0Y8",
"id": "ENTITY2Ihjasdjkeru",
"type": "vendor",
"name": "Name of the Account",
"validPaymentMethod": false
}
}
]
提示:是否发现了多个配置文件?
每个配置文件代表不同站点中的一个广告账户。通过查看
countryCode
值来确定给定配置文件对应的站点。
提示:未发现任何配置文件?
响应消息体中的空数组 (
[ ]
) 表示授权成功,但用户账户没有在该地区站点拥有查看和编辑权限的广告账户。有关地区站点的信息,请参阅 API 接口。
您可以在请求中使用可选参数来展示您具有只读权限的配置文件。进一步了解权限,或者参阅配置文件规范中的accessLevel
和apiProgram
参数。
即使您没有访问任何地区站点的广告账户,您也可以使用批准的 LwA 客户端为 API 生成测试账户。进一步了解测试账户。
提示:正在使用管理员账户?
如果授权请求的用户账户是一个管理账户,则响应将包括管理账户在当前地区站点中具有编辑者访问权限的所有广告账户。对于仅具有查看者权限的账户,请使用
GET /managerAccounts
接口检索配置文件标识符。进一步了解管理员账户。
在后续请求中传递配置文件标识符
除了 /v2/profiles
接口外,对亚马逊广告 API 的请求只能访问一个配置文件的资源。所选配置文件是通过将配置文件标识符作为 Amazon-Advertising-API-Scope
标头的值传递来确定。
对于 API 的后续请求,您将通过以下三个必需标头的值传递您的客户端编号、访问令牌和配置文件标识符:
Amazon-Advertising-API-ClientID
: 您的客户编号。Authorization
: 加在访问令牌之前的Bearer
字符串。Amazon-Advertising-API-Scope
: 特定站点的广告账户的配置文件标识符。
注意
访问令牌在 60 分钟后过期,使用过期的访问令牌发出的请求将收到一个
Unauthorized
响应。要在需要时生成新令牌,请参阅使用刷新令牌生成访问令牌。
后续步骤
要开始使用您的凭据,请参阅进行首次调用。
技术支持
如果您在连接亚马逊广告 API 时遇到困难,请访问我们的技术支持页面以获取有关帮助的信息。