客户端库

我们的客户端库提供 Google Ads API 功能的总体视图和基础构成部分,可帮助您更轻松地快速开发应用。如果您刚开始使用该 API,我们建议您先从该 API 入手。

客户端库 来源 分布 代码示例
Java google-ads-java Maventar.gz 在 GitHub 上查看
.NET google-ads-dotnet tar.gz、zip 在 GitHub 上查看
PHP google-ads-php tar.gz 在 GitHub 上查看
Python google-ads-python tar.gz、zip 在 GitHub 上查看
Ruby google-ads-ruby gem、tar.gz、zip 在 GitHub 上查看
PERL google-ads-perl tar.gz、zip 在 GitHub 上查看

支持的 API 版本

下表列出了支持每个可用 API 版本的具体库版本。

API 版本 Python 库版本 Ruby 库版本 PHP 库版本 Java 库版本 .NET 库版本 Perl 库版本
11 版 >= 17.0.0 >= 18.0.0 >=15.1.0 >= 19.0.0 >= 12.1.0 >= 12.0.0
版本 10 >= 15.0.0 >= 16.0.0 >= 14.0.0 >= 17.0.0 >= 11.0.0 >= 10.0.0
版本 9 >= 14.1.0 >= 15.0.0 >= 12.1.0 >= 16.0.0 >= 10.2.0 >= 9.2.0

配置

每个 Ads API 客户端库都提供不同的配置设置和加载方法,供您自定义其行为。

以下是所有客户端库通用且可加载以配置配置设置的环境变量:

  • 客户端库
    • GOOGLE_ADS_CONFIGURATION_FILE_PATH:配置文件的路径。
  • OAuth2
    • 应用模式
      • GOOGLE_ADS_CLIENT_ID:将此值设为您的 OAuth2 客户端 ID。
      • GOOGLE_ADS_CLIENT_SECRET:将此值设为您的 OAuth2 客户端密钥。
      • GOOGLE_ADS_REFRESH_TOKEN:如果您想重复使用 OAuth2 令牌,请将此值设置为预生成的 OAuth2 刷新令牌。此设置是可选的。
    • 服务帐号模式
      • GOOGLE_ADS_JSON_KEY_FILE_PATH:将此值设为 OAuth2 JSON 配置文件路径。
      • GOOGLE_ADS_IMPERSONATED_EMAIL:请将此值设为您要模拟的帐号的电子邮件地址。
  • Google Ads API
    • GOOGLE_ADS_DEVELOPER_TOKEN:将此项设置为您的开发者令牌。
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID:这是要在请求中使用的授权客户 ID,不带连字符 (-)。
    • GOOGLE_ADS_LINKED_CUSTOMER_ID:仅在通过 Google Ads 界面(Google Ads API 中的 AccountLink 资源)获得链接权限时更新实体资源的方法才需要此标头。并将此值设置为数据更新客户指定 ID 的资源的数据 ID。但不设置连字符 (-)。如需详细了解关联的帐号,请访问帮助中心