本指南使用客户端库来检索 Google Ads 广告系列。
如需启用 API 访问权限,请先获取所需的 OAuth2 凭据。
然后,将授权和帐号详细信息添加到配置文件中。设置完配置文件后,您就可以调用 API 了。
客户端库的配置参数
在客户端库的配置文件中提供以下信息。
- 开发者令牌
您的开发者令牌可让您的应用访问 API,但令牌并不限于一个 Google Ads 帐号。一旦您的令牌获得批准,您就可以将同一令牌用于针对所有 Google Ads 帐号的请求,即使它们未关联到与此令牌关联的 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 访问令牌。否则,请尝试通过 OAuth Playground 获取令牌。
OAuth2 访问令牌会在限定时间后过期。因此,客户端库使用 OAuth2 刷新令牌,以便自动重新生成 OAuth2 访问令牌。访问令牌和刷新令牌提供了有关创建刷新令牌的说明。