授权和 HTTP 标头

视频:身份验证

您需要 OAuth 2.0 应用凭据和开发者 令牌。如果您在进行 API 调用时 使用 Google Ads 经理账号时,您还需要指定一个 login-customer-id 标头。本页介绍了如何设置这些值, 记录了系统发送的几个其他特定于 API 的 HTTP 标头, 收到的所有请求

OAuth 2.0 凭据

Google Ads API 使用应用凭据识别和授权 API 请求。OAuth 2.0 客户端和服务 账号。了解详情 有关配置客户端授权的信息,请参阅 Google Ads API

如果您刚开始接触 Google API,可以使用 oauth2lOAuth 2.0 Playground(可试用) 您的应用程序凭据和 Google Ads API,然后再为您的应用程序编写代码。 应用。

使用桌面应用流程或 Web 应用流程

请按照步骤为 Google Ads API。记录客户端 ID客户端密钥,然后返回此页面。

创建 OAuth 客户端后,请按照桌面应用流程操作 说明网络应用流程 操作说明 生成刷新令牌访问令牌

使用服务账号

请按照 Service 账号 为 Google Ads API 设置服务账号访问权限的指南。

设置用于访问 Google Ads 账号的服务账号后, 针对服务器到服务器使用 OAuth 2.0 应用 指南,请务必选择 HTTP/REST 标签页。用于 Google Ads API 的 scope 访问权限为https://www.googleapis.com/auth/adwords

生成新的访问令牌

有了客户端 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

然后,您可以使用 Authorization HTTP 标头:

GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

请求标头

开发者令牌

Google Ads API 还需要开发者令牌才能调用 该 API。您可以直接在以下位置为您的经理账号申请令牌: Google Ads 界面。如需详细了解如何设置开发者令牌,请参阅 获取您的开发者令牌

您需要将自己的开发者令牌值添加到 developer-token HTTP 标头:

GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN

登录客户 ID

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

添加此标头相当于在 Google Ads 界面中选择账号 登录后,请点击位于 页面。在指定客户 ID 时,请务必移除所有连字符 (—)、 例如:1234567890,而不是 123-456-7890

GET /v17/customers:listAccessibleCustomers HTTP/1.1
Host: googleads.googleapis.com
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID

关联的客户 ID

只有在满足以下条件时,第三方应用分析工具提供商才会使用此标头: 将转化数据上传到关联的 Google Ads 账号。请参阅 API 调用结构指南 了解详情。

...
Authorization: Bearer ACCESS_TOKEN
developer-token: DEVELOPER_TOKEN
login-customer-id: MANAGER_CUSTOMER_ID
linked-customer-id: LINKED_CUSTOMER_ID

响应标头

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

请求 ID

request-id 是唯一标识 API 请求的字符串。时间 调试或排查特定 API 调用的问题时,request-id 是与 Google 开发者联系时需要使用的重要标识符 联系。

request-id: 2a5Cj89VV7CNhya1DZjjrC