クライアント ライブラリ

クライアント ライブラリには、Google Ads API 機能の概要ビューや基本的な構成要素が用意されているため、アプリを短時間で簡単に開発できます。API を初めて使用する場合は、まず 1 つから始めることをおすすめします。

クライアント ライブラリ ソース 分布 コードの例
Java google-ads-java Maven, tar.gz GitHub で表示
.NET google-ads-dotnet nugettar.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 広告の管理画面でリンクされたアカウント(Google Ads API の AccountLink リソース)を通じて権限が付与されている場合に、エンティティのリソースを更新するメソッドにのみ必要です。指定したお客様 ID のリソースを更新するデータ プロバイダのお客様 ID をこの値に設定します。ハイフン(-)なしで設定する必要があります。リンクされたアカウントについて詳しくは、ヘルプセンターをご覧ください。

環境変数は通常、$HOME ディレクトリにある .bashrc ファイルや .bash_profile ファイルなどの bash 構成ファイルで定義されます。コマンドラインを使用して定義することもできます。

ターミナルを使用して .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 は通常、結果ページを表示するインタラクティブ アプリで使用されます。ページサイズは 1 ページあたり 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());
      }
    }
  }
}
      

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;
    }
}
      

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
        );
    }
}
      

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.'
            )
      

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
      

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;
}
      

コードの例

Google Ads API の一般的な関数のコードサンプルをご確認ください