本指南使用客户端库来检索 Google Ads 广告系列。
要启用 API 访问权限,请先获取所需的 OAuth2 凭据。然后,将授权和帐号详细信息添加到配置文件中。配置文件设置完毕后,您就可以调用该 API 了。
前提条件
配置参数
您需要在客户端库的配置文件中提供以下信息。
- 开发者令牌
您的开发者令牌可让您的应用访问 API,但令牌不仅限于一个 Google Ads 帐号。一旦您的令牌获得批准,您就可以将同一令牌用于针对所有 Google Ads 帐号的请求,即使它们未关联到与此令牌关联的 Google Ads 经理帐号也是如此。您管理的帐号由经理帐号的 OAuth 凭据授权。经理帐号只需要一组凭据即可管理其所有子帐号。
只有经过批准的令牌才能连接到生产 Google Ads 帐号的 API;待处理令牌只能连接到测试帐号。
要检索您的开发者令牌,您可以登录您的经理帐号,然后导航到 API 中心(TOOLS & SETTINGS > SETUP > API Center)。
要点
- 一家公司应只有一个开发者令牌。
- 一旦 Google Cloud 项目中的客户端 ID 与开发者令牌一起使用,该客户端 ID 便会绑定到该开发者令牌,并且不能与其他开发者令牌一起使用。换句话说:
- 一个开发者令牌可与多个客户端 ID 配合使用。
- 不过,客户端 ID 只能与一个开发者令牌一起使用。
- 客户帐号的客户 ID
客户帐号的客户 ID 是要通过 API 管理的 Google Ads 客户帐号的帐号编号,通常其格式为
123-456-7890
。您可以选择将客户帐号的客户 ID 留在配置文件之外,并采用编程方式进行设置。在您的开发者令牌获得批准后,您就可以使用来自生产帐号的客户帐号的客户 ID,而不是测试帐号。
- OAuth2 客户端 ID 和客户端密钥
OAuth2 客户端 ID 和客户端密钥将客户端应用映射到 Google API 控制台中的项目,用于 OAuth2 身份验证,让您的应用代表您的帐号进行操作。它们可向 Google 标识您的应用,并允许您生成用于管理 Google Ads 用户的 OAuth 令牌。
有关详情,请参阅创建客户端 ID 和客户端密钥。
- OAuth2 访问令牌和刷新令牌
您的应用必须先获取用于授予 API 访问权限的 OAuth2 访问令牌,才可以使用 API 访问非公开数据。
如果您使用的是客户端库,系统会自动为您处理 OAuth2 访问令牌。否则,请参阅 OAuth2 指南中的 API 调用示例,详细了解如何生成访问令牌。
OAuth2 访问令牌会在限定时间后过期。因此,客户端库使用 OAuth2 刷新令牌来自动生成 OAuth2 访问令牌。
OAuth2 访问令牌和刷新令牌提供了有关创建刷新令牌的说明。
如需详细了解如何将 OAuth2 与 Google API 搭配使用,请参阅 OAuth2 身份验证和 OAuth2 身份平台文档。