授权和 HTTP 标头

调用 Search Ads 360 Reporting API 时,您需要 OAuth 2.0 应用凭据。如果您以 Search Ads 360 经理账号,还需要指定 login-customer-id 标头 。本页面介绍了如何设置这些值, 发送和接收的几个额外 API 特定的 HTTP 标头 使用 REST 接口

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客户端密钥刷新令牌后,您可以 生成用于 API 调用的新访问令牌,其中使用 curl 命令行工具:

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

然后使用 curl 请求返回的访问令牌 对 Search Ads 360 Reporting API 的每个 API 调用的 Authorization HTTP 标头:

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