授权和 HTTP 标头

调用 Search Ads 360 Reporting API 时,您需要 OAuth 2.0 应用凭据。如果您以 Search Ads 360 经理帐号的身份进行 API 调用,则还需要为每个请求指定 login-customer-id 标头。本页介绍了如何设置这些值,并记录了使用 REST 接口时发送和接收的几个额外的 API 专用 HTTP 标头。

OAuth 2.0 凭据

Search Ads 360 Reporting API 使用应用凭据识别 API 请求和向其授权。您可以配置 OAuth 2.0 客户端。所有 Search Ads 360 Reporting API 调用都必须通过 OAuth2 进行授权。借助 OAuth2,您的 Search Ads 360 Reporting API 客户端应用就能够访问用户的 Search Ads 360 帐号,而无需处理或存储用户的登录信息。

如果您刚开始接触 Google API,可以使用 oauth2lOAuth 2.0 Playground 来试验应用凭据和 Search Ads 360 Reporting API,然后再为应用编写代码。您还可以通过运行提供的用户凭据生成脚本来生成 OAuth 刷新令牌。

生成新的访问令牌

在拥有客户端 ID客户端密钥刷新令牌后,您可以生成新的访问令牌,用于通过 curl 命令行工具进行 API 调用:

curl \
  --data "grant_type=refresh_token" \
  --data "client_id=CLIENT_ID" \
  --data "client_secret=CLIENT_SECRET" \
  --data "refresh_token=REFRESH_TOKEN" \
  https://www.googleapis.com/oauth2/v3/token

然后,您可以在每次对 Search Ads 360 Reporting API 的 API 调用的 Authorization HTTP 标头中使用 curl 请求返回的访问令牌

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN

请求标头

登录客户 ID

对于经理对客户帐号进行的 Search Ads 360 Reporting API 调用(即,以经理身份登录时对其某个客户帐号进行 API 调用时),您还需要提供 login-customer-id HTTP 标头。此值表示进行 API 调用的经理账号的 Search Ads 360 客户 ID。

添加此标题的作用相当于在登录或点击页面右上角的个人资料图片后,在 Search Ads 360 界面中选择帐号。指定客户 ID 时,请务必移除所有连字符 (-),例如 1234567890,而不是 123-456-7890

GET /v0/customers:listAccessibleCustomers HTTP/1.1
Host: searchads360.googleapis.com
Authorization: Bearer ACCESS_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

响应标头

该 API 的 HTTP 响应中会返回以下标头。

要求 ID

request-id 是一个字符串,用于唯一标识 API 请求。在调试或排查特定 API 调用的问题时,request-id 是一个重要的标识符,您可以在与 Google 开发者支持团队联系时随时使用。

request-id: 2a5Cj89VV7CNhya1DZjjrC