客户端库

我们的客户端库提供 Google Ads API 功能的高级视图和基本构建块，以便您更轻松地快速开发应用。如果您刚开始使用该 API，建议您先从一个开始。

客户端库	来源	分布	代码示例
Java	google-ads-java	Maven、tar.gz	在 GitHub 上查看
.NET	google-ads-dotnet	nuget、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 上查看

社区库

我们知道有多个库是由开源社区维护的。我们会维护此列表，以帮助感兴趣的开发者找到这些服务。我们不会测试、贡献或维护这些库；使用这些库的风险由您自行承担。如有任何疑问，请咨询开源项目的所有者。

如果您知道我们遗漏了某个库，请点击页面顶部的发送反馈告知我们。

• NodeJS：https://www.npmjs.com/package/google-ads-api

• Go：https://github.com/shenzhencenter/google-ads-pb

支持的 API 版本

下表显示了哪些客户端库适用于哪些 API 版本。

Java

Google Ads API	Java 版客户端库
v20	Min: 38.0.0 Max: -
v19	Min: 36.0.0 Max: -
v18	Min: 34.0.0 Max: -
v17	Min: 31.0.0 Max: 36.1.0

C#

Google Ads API	适用于 .NET 的客户端库
v20	Min: 23.0.0 Max: -
v19	Min: 22.1.0 Max: -
v18	Min: 21.1.0 Max: -
v17	Min: 20.1.0 Max: 22.2.0

PHP

Google Ads API	PHP 版客户端库
v20	Min: 28.0.0 Max: -
v19	Min: 26.1.0 Max: -
v18	Min: 25.0.0 Max: -
v17	Min: 23.1.0 Max: 27.2.0

Python

Google Ads API	适用于 Python 的客户端库
v20	Min: 27.0.0 Max: -
v19	Min: 25.2.0 Max: -
v18	Min: 25.1.0 Max: -
v17	Min: 24.1.0 Max: 26.1.0

Ruby

Google Ads API	Ruby 版客户端库
v20	Min: 34.0.0 Max: -
v19	Min: 32.0.0 Max: -
v18	Min: 31.0.0 Max: -

Perl

Google Ads API	适用于 Perl 的客户端库
v20	Min: 27.0.0 Max: -
v19	Min: 26.0.0 Max: -
v18	Min: 25.0.1 Max: -

配置

每个 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。应不含连字符 (-)。如需详细了解关联的账号，请访问帮助中心。

注意 ：如需详细了解如何使用这些变量以及任何其他特定于客户端库的环境变量，请参阅专门针对每个客户端库的配置指南：Java、.NET、PHP、Python、Ruby、Perl。

环境变量通常在 bash 配置文件中定义，例如位于 $HOME 目录中的 .bashrc 或 .bash_profile 文件。也可以使用命令行定义它们。

注意： 以下说明假定您使用的是 Bash。如果您使用的是其他 shell，请参阅文档以了解等效命令。

以下是使用终端通过 .bashrc 文件定义环境变量的一些基本步骤：

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc

# Update your bash environment to use the most recently updated
# version of your .bashrc file.
src ~/.bashrc

您还可以直接从命令行在终端实例中设置环境变量：

export GOOGLE_ADS_CLIENT_ID=1234567890

另一种方法是在调用使用环境变量的命令时设置环境变量：

GOOGLE_ADS_CLIENT_ID=1234567890 php /path/to/script/that/uses/envvar.php

提取实体

GoogleAdsService.SearchStream 通常用于提取实体，结果以行数据流的形式返回。或者，您也可以使用 GoogleAdsService.Search 通过不可靠的网络连接来提取实体。GoogleAdsService.Search 以固定页面大小（每页 10,000 行）返回结果。

当您迭代结果时，我们的客户端库会自动实现分页，以便您可以一次性按顺序下载并处理所有结果。

Java

private void runExample(GoogleAdsClient googleAdsClient, long customerId) {
  try (GoogleAdsServiceClient googleAdsServiceClient =
      googleAdsClient.getLatestVersion().createGoogleAdsServiceClient()) {
    String query = "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id";
    // Constructs the SearchGoogleAdsStreamRequest.
    SearchGoogleAdsStreamRequest request =
        SearchGoogleAdsStreamRequest.newBuilder()
            .setCustomerId(Long.toString(customerId))
            .setQuery(query)
            .build();

    // Creates and issues a search Google Ads stream request that will retrieve all campaigns.
    ServerStream<SearchGoogleAdsStreamResponse> stream =
        googleAdsServiceClient.searchStreamCallable().call(request);

    // Iterates through and prints all of the results in the stream response.
    for (SearchGoogleAdsStreamResponse response : stream) {
      for (GoogleAdsRow googleAdsRow : response.getResultsList()) {
        System.out.printf(
            "Campaign with ID %d and name '%s' was found.%n",
            googleAdsRow.getCampaign().getId(), googleAdsRow.getCampaign().getName());
      }
    }
  }
}
GetCampaigns.java
      

C#

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V20.GoogleAdsService);

    // Create a query that will retrieve all campaigns.
    string query = @"SELECT
                    campaign.id,
                    campaign.name,
                    campaign.network_settings.target_content_network
                FROM campaign
                ORDER BY campaign.id";

    try
    {
        // Issue a search request.
        googleAdsService.SearchStream(customerId.ToString(), query,
            delegate (SearchGoogleAdsStreamResponse resp)
            {
                foreach (GoogleAdsRow googleAdsRow in resp.Results)
                {
                    Console.WriteLine("Campaign with ID {0} and name '{1}' was found.",
                        googleAdsRow.Campaign.Id, googleAdsRow.Campaign.Name);
                }
            }
        );
    }
    catch (GoogleAdsException e)
    {
        Console.WriteLine("Failure:");
        Console.WriteLine($"Message: {e.Message}");
        Console.WriteLine($"Failure: {e.Failure}");
        Console.WriteLine($"Request ID: {e.RequestId}");
        throw;
    }
}
GetCampaigns.cs
      

PHP

public static function runExample(GoogleAdsClient $googleAdsClient, int $customerId)
{
    $googleAdsServiceClient = $googleAdsClient->getGoogleAdsServiceClient();
    // Creates a query that retrieves all campaigns.
    $query = 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id';
    // Issues a search stream request.
    /** @var GoogleAdsServerStreamDecorator $stream */
    $stream = $googleAdsServiceClient->searchStream(
        SearchGoogleAdsStreamRequest::build($customerId, $query)
    );

    // Iterates over all rows in all messages and prints the requested field values for
    // the campaign in each row.
    foreach ($stream->iterateAllElements() as $googleAdsRow) {
        /** @var GoogleAdsRow $googleAdsRow */
        printf(
            "Campaign with ID %d and name '%s' was found.%s",
            $googleAdsRow->getCampaign()->getId(),
            $googleAdsRow->getCampaign()->getName(),
            PHP_EOL
        );
    }
}
GetCampaigns.php
      

Python

def main(client, customer_id):
    ga_service = client.get_service("GoogleAdsService")

    query = """
        SELECT
          campaign.id,
          campaign.name
        FROM campaign
        ORDER BY campaign.id"""

    # Issues a search request using streaming.
    stream = ga_service.search_stream(customer_id=customer_id, query=query)

    for batch in stream:
        for row in batch.results:
            print(
                f"Campaign with ID {row.campaign.id} and name "
                f'"{row.campaign.name}" was found.'
            )
get_campaigns.py
      

Ruby

def get_campaigns(customer_id)
  # GoogleAdsClient will read a config file from
  # ENV['HOME']/google_ads_config.rb when called without parameters
  client = Google::Ads::GoogleAds::GoogleAdsClient.new

  responses = client.service.google_ads.search_stream(
    customer_id: customer_id,
    query: 'SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id',
  )

  responses.each do |response|
    response.results.each do |row|
      puts "Campaign with ID #{row.campaign.id} and name '#{row.campaign.name}' was found."
    end
  end
end
get_campaigns.rb
      

Perl

sub get_campaigns {
  my ($api_client, $customer_id) = @_;

  # Create a search Google Ads stream request that will retrieve all campaigns.
  my $search_stream_request =
    Google::Ads::GoogleAds::V20::Services::GoogleAdsService::SearchGoogleAdsStreamRequest
    ->new({
      customerId => $customer_id,
      query      =>
        "SELECT campaign.id, campaign.name FROM campaign ORDER BY campaign.id"
    });

  # Get the GoogleAdsService.
  my $google_ads_service = $api_client->GoogleAdsService();

  my $search_stream_handler =
    Google::Ads::GoogleAds::Utils::SearchStreamHandler->new({
      service => $google_ads_service,
      request => $search_stream_request
    });

  # Issue a search request and process the stream response to print the requested
  # field values for the campaign in each row.
  $search_stream_handler->process_contents(
    sub {
      my $google_ads_row = shift;
      printf "Campaign with ID %d and name '%s' was found.\n",
        $google_ads_row->{campaign}{id}, $google_ads_row->{campaign}{name};
    });

  return 1;
}
get_campaigns.pl
      

代码示例

查看我们的代码示例，了解 Google Ads API 中的一些常用函数。