クライアント ライブラリ

クライアント ライブラリは、Google Ads 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

API とサポートされている最小 Java バージョンと最大 Java バージョン
バージョン 12 Min: 22.0.0
Max: -
v11 Min: 19.0.0
Max: -
バージョン 10 Min:17.0.0
Max: -

C#

API とサポートされている最小/最大 .NET バージョン
バージョン 12 Min: 14.2.0
Max: -
v11 Min:12.1.0
Max:
バージョン 10 Min: 11.0.0
Max: -

PHP

API とサポートされている最小 PHP/最大 PHP バージョン
バージョン 12 Min:17.1.0
Max:
v11 Min: 15.1.0
Max: -
バージョン 10 Min:14.0.0
Max:

Python

API とサポートされている最小 Python バージョンと最大 Python バージョン
バージョン 12 Min: 19.0.0
Max: -
v11 Min:17.0.0
Max: -
バージョン 10 Min:15.0.0
Max:

Ruby

API とサポートされている最小/最大 Ruby バージョン
バージョン 12 Min: 20.0.0
Max: -
v11 Min:18.0.0
Max:
バージョン 10 Min:16.0.0
Max:

Perl

API とサポートされている最小/最大バージョン
バージョン 12 Min:14.0.0
Max:
v11 Min: 12.0.0
Max: -
バージョン 10 Min:10.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 に設定します。ハイフン(-)は含めないでください。リンクされたアカウントについて詳しくは、ヘルプセンターをご覧ください。