客户端库

我们的客户端库提供了 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 上查看

支持的 API 版本

下表显示了哪些客户端库与哪些 API 版本配合使用。

Java

Java 版客户端库
v18 Min: 34.0.0
Max: -
v17 Min: 32.0.0
Max: -
v16 Min: 30.0.0
Max: -

C#

适用于 .NET 的客户端库
v18 Min: 21.1.0
Max: -
v17 Min: 20.1.0
Max: -
v16 Min: 18.1.0
Max: -

PHP

PHP 版客户端库
v18 Min: 25.0.0
Max: -
v17 Min: 23.1.0
Max: -
v16 Min: 22.1.0
Max: -

Python

适用于 Python 的客户端库
v18 Min: 25.1.0
Max: -
v17 Min: 24.1.0
Max: -
v16 Min: 23.1.0
Max: -

Ruby

Ruby 版客户端库
v18 Min: 31.0.0
Max: -
v17 Min: 29.0.0
Max: -
v16 Min: 27.0.0
Max: -

Perl

适用于 Perl 的客户端库
v18 Min: 25.0.0
Max: -
v17 Min: 23.0.0
Max: -
v16 Min: 21.0.0
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。设置时不应使用连字符 (-)。如需详细了解关联的账号，请访问帮助中心。

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

以下是使用终端通过 .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.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.V18.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::V18::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 中的一些常用函数。