在此快速入门中,您可以使用客户端库检索您的 Google Ads 广告系列。要启用 API 访问权限,您需要先获取所需的 OAuth2 凭据。然后,将授权和帐号详细信息添加到配置文件中。设置完配置文件后,您就可以对 API 进行调用了。
前提条件
配置参数
您需要在客户端库的配置文件中提供以下信息。
- 开发者令牌
开发者令牌授予的是 API 的访问权限,不是特定帐号的访问权限。一旦您的令牌获得批准,您就可以将同一令牌用于针对所有 Google Ads 帐号的请求,即使它们未关联到与此开发者令牌相关联的经理帐号,也是如此。您管理的帐号均由经理帐号的专属 OAuth 凭据进行授权。换句话说,经理帐号只需要一组凭据即可管理所有子帐号。
只有经过批准的令牌才能连接到生产 Google Ads 帐号的 API;待处理令牌只能连接到测试帐号。
要检索您的开发者令牌,您可以登录您的经理帐号,然后前往 API 中心(工具 > 设置 > API 中心)。
- 客户帐号的客户 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 身份平台文档。
测试帐号(可选)
生产帐号会投放广告向用户呈现,并会涉及结算流程。测试帐号不会影响您已投放的广告,也不会向您的帐号收费,因此它们不过是一种非常有用的 API 测试方式。由于测试帐号不投放任何实际的广告,所以 API 调用中的展示次数或费用数据通常都是零。
按照以下说明创建测试经理帐号、测试客户帐号和几个广告系列以填充测试客户帐号。请注意,这里的“客户”(client) 一词指的是 Google Ads 客户帐号,而不是您的客户端应用。
转到 Google Ads 经理帐号页面,创建测试经理帐号。
打开 Google Ads 界面,在之前创建的测试经理帐号下创建测试客户帐号。当您以测试经理帐号登录 Google Ads 时,您创建的所有客户帐号都将自动成为测试帐号。
使用 Google Ads 界面,在测试客户帐号下创建几个测试广告系列。
记下并保存新测试客户帐号的客户 ID。稍后再将其添加到配置文件中。