クライアント ライブラリ

Google のクライアント ライブラリは、Google Ads API 機能の概要と基本的な構成要素を備えているため、アプリの開発も容易です。API を初めて使用する場合は、この API から始めることをおすすめします。

クライアント ライブラリ ソース 分布 コードの例
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 用のクライアント ライブラリ
v13 Min: 23.0.0
Max:
v12 Min: 22.0.0
Max:

C#

.NET 用のクライアント ライブラリ
v13 Min: 15.0.0
Max:
v12 Min: 14.2.0
Max:

PHP

PHP 用クライアント ライブラリ
v13 Min: 18.0.0
Max:
v12 Min: 17.1.0
Max:

Python

Python 用のクライアント ライブラリ
v13 Min: 20.0.0
Max:
v12 Min: 19.0.0
Max:

Ruby

Ruby 用クライアント ライブラリ
v13 Min: 21.0.0
Max:
v12 Min: 20.0.0
Max:

Perl

Perl 用クライアント ライブラリ
v13 Min: 15.0.0
Max:
v12 Min: 14.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 広告 UI の [リンクされたアカウント](Google Ads API の AccountLink リソース)で権限が付与されている場合に、エンティティのリソースを更新するメソッドにのみ必要です。この値は、指定した顧客 ID のリソースを更新するデータ プロバイダの顧客 ID に設定します。ハイフンは設定しないでください(-)。リンクされたアカウントの詳細については、ヘルプセンターをご覧ください。