クライアント ライブラリ

クライアント ライブラリには、Google Ads API の機能の概要と基本的な構成要素が備わっているため、アプリの開発も簡単です。API を初めて使用する場合は、まずこの API を使用することをおすすめします。

クライアント ライブラリ ソース 分散 コードの例
Java google-ads-java Maven, tar.gz GitHub で表示
.NET google-ads-dotnet 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 で表示
パール google-ads-perl tar.gz、zip GitHub で表示

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

下記の表は、利用可能な各 API バージョンをサポートする特定のライブラリ バージョンを示しています。

API のバージョン Python ライブラリのバージョン Ruby ライブラリのバージョン PHP ライブラリのバージョン Java ライブラリのバージョン .NET ライブラリのバージョン Perl ライブラリのバージョン
v11 >= 17.0.0 >= 18.0.0 >=15.1.0 >= 19.0.0 >= 12.1.0 >= 12.0.0
v10 >= 15.0.0 >= 16.0.0 >= 14.0.0 >= 17.0.0 >= 11.0.0 >= 10.0.0
v9 >= 14.1.0 >= 15.0.0 >= 12.1.0 >= 16.0.0 >= 10.2.0 >= 9.2.0

構成

各 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 に設定します。ハイフン(-)を設定しないでください。リンクされたアカウントについて詳しくは、ヘルプセンターをご覧ください。