クライアント ライブラリ

Google Ads API クライアント ライブラリは、Google Ads API 機能の概要と基本的な構成要素を提供するため、アプリを短時間で容易に開発することが可能になります。API を初めて使用する場合は、クライアント ライブラリから始めます。

クライアント ライブラリ ソース 分布 コードの例
Java google-ads-java Maven、tar.gz、zip GitHub で表示
.NET google-ads-dotnet NuGet、tar.gz、zip GitHub で表示
PHP google-ads-php Composer、tar.gz、zip GitHub で表示
Python google-ads-python PyPI、tar.gz、zip GitHub で表示
Ruby google-ads-ruby RubyGems、tar.gz、zip GitHub で表示
Perl google-ads-perl CPAN、tar.gz、zip GitHub で表示

コミュニティ ライブラリ

オープンソース コミュニティによって管理されているライブラリがいくつかあります。このリストは、関心のあるデベロッパーがパートナーを見つけられるようにするために維持されています。これらのライブラリはテスト、投稿、メンテナンスを行っていません。ご自身の責任で使用してください。ご不明な点がある場合は、オープンソース プロジェクトのオーナーにお問い合わせください。

見落としているライブラリがある場合は、ページ上部の [フィードバックを送信] をクリックしてお知らせください。

サポートされている API バージョン

次の表に、どのクライアント ライブラリがどの API バージョンで動作するかを示します。

記載されている最小クライアント ライブラリ バージョンは、Google Ads API のメジャー リリース(v25 など)で十分です。マイナー リリースに必要なクライアント ライブラリのバージョンについては、リンクされている変更ログをご覧ください。

Java

変更履歴

Java 用のクライアント ライブラリ
v25 Min: 44.0.0
Max: -
v24 Min: 43.0.0
Max: -
v23 Min: 42.0.0
Max: -

C#

変更履歴

.NET 用のクライアント ライブラリ
v25 Min: 26.1.0
Max: -
v24 Min: 25.3.0
Max: -
v23 Min: 25.1.0
Max: -

PHP

変更履歴

PHP 用クライアント ライブラリ
v25 Min: 33.6.0
Max: -
v24 Min: 33.3.0
Max: -
v23 Min: 32.2.0
Max: -

Python

変更履歴

Python 用のクライアント ライブラリ
v25 Min: 31.2.0
Max: -
v24 Min: 30.1.0
Max: -
v23 Min: 29.2.0
Max: -

Ruby

変更履歴

Ruby 用クライアント ライブラリ
v25 Min: 43.0.0
Max: -
v24 Min: 40.0.0
Max: -
v23 Min: 38.0.0
Max: -

Perl

変更履歴

Perl 用のクライアント ライブラリ
v25 Min: 33.0.0
Max: -
v24 Min: 32.0.0
Max: -
v23 Min: 31.0.0
Max: -

構成

Google Ads API クライアント ライブラリごとに、動作をカスタマイズするために使用できるさまざまな構成設定と読み込み方法が用意されています。

クライアント ライブラリの構成に使用できる標準の環境変数は次のとおりです。

  • クライアント ライブラリ
    • GOOGLE_ADS_CONFIGURATION_FILE_PATH: 構成ファイルのパス(Java(fromPropertiesFile())、Perl(Client->new())、PHP(fromFile())、Python(load_from_storage()、load_from_env() でもチェック)、Ruby(GoogleAdsClient.new)で明示的なパス引数なしで構成ファイルから読み込むときに自動的に読み取られます。.NET では、config.TryLoadFromEnvironmentFilePath を使用してこの変数を明示的に読み込むか、LoadFromSettingsJson、LoadFromConfigurationSection、LoadFromConfigurationRoot を使用して構成ファイルを読み込みます)。
  • 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 キーファイルのパスに設定します(.NET で GOOGLE_ADS_OAUTH2_MODE を SERVICE_ACCOUNT に設定します。OAuth2Mode はデフォルトで APPLICATION に設定されています。v32.1.0 より前の PHP バージョンまたはカスタム スコープを使用する場合は、google_ads_php.ini で [OAUTH2] scopes を設定するか、withScopes() を呼び出します。fromEnvironmentVariables() は環境変数から OAuth2 スコープを読み取らないためです)。
      • GOOGLE_ADS_IMPERSONATED_EMAIL: Google Workspace のドメイン全体の委任を使用する場合は、この値を権限借用するアカウントのメールアドレスに設定します。この設定は省略可能です。
    • アプリケーションのデフォルト認証情報モード
      • GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS: アプリケーションのデフォルト認証情報(ADC)を使用して認証するには、この値を true に設定します。Java v41.1.0 以降、Python v28.3.0 以降、Ruby v36.1.0 以降でサポートされています(.NET v24.1.0 以降では、LoadFromEnvironmentVariables() は接頭辞のない USE_APPLICATION_DEFAULT_CREDENTIALS 変数を読み取るか、GoogleAdsConfig で UseApplicationDefaultCredentials = true を設定します。PHP では、明示的な OAuth2 認証情報が設定されていない場合、OAuth2TokenBuilder は自動的に ADC にフォールバックします。Perl は ADC をサポートしていません)。
  • Google Ads API
    • GOOGLE_ADS_DEVELOPER_TOKEN: 最新リリースでは省略可(Java v46.0.0 以降、.NET v27.3.0 以降、PHP v35.0.0 以降、Python v32.0.0 以降、Ruby v45.0.0 以降、Perl v35.0.0 以降)。デベロッパー トークンは 2026 年 9 月 9 日に廃止されました。API サーバーは、クライアント ライブラリのバージョンに関係なく developer-token ヘッダーを無視します(Google Ads API の将来のメジャー バージョンで拒否されるまで)。以前のクライアント ライブラリ バージョンでは、ローカル クライアントサイド検証に空でない値が必要です。バージョン固有の詳細については、各ライブラリの構成ガイドをご覧ください。
    • GOOGLE_ADS_LOGIN_CUSTOMER_ID: リクエストで使用する承認済みのお客様の ID(ハイフンなし)(-)。
    • GOOGLE_ADS_LINKED_CUSTOMER_ID: このヘッダーは、Google 広告 UI のリンク済みアカウント(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.
source ~/.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());
      }
    }
  }
}
      

C#

public void Run(GoogleAdsClient client, long customerId)
{
    // Get the GoogleAdsService.
    GoogleAdsServiceClient googleAdsService = client.GetService(
        Services.V25.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: GoogleAdsClient, customer_id: str) -> None:
    ga_service: GoogleAdsServiceClient = client.get_service("GoogleAdsService")

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

    # Issues a search request using streaming.
    stream: Iterator[SearchGoogleAdsStreamResponse] = ga_service.search_stream(
        customer_id=customer_id, query=query
    )

    for batch in stream:
        rows: List[GoogleAdsRow] = batch.results
        for row in rows:
            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::V25::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;
}
      

curl

コードの例

Google Ads API の一般的な関数のコード例をご覧ください。