クライアント ライブラリ

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

Google のクライアント ライブラリでは、Google Ads API の機能の概要と基本的な構成要素が提供されています。これにより、アプリの迅速な開発が容易になります。API を初めてご利用になる場合は、最初は API を使用することをおすすめします。

クライアント ライブラリ Source 分布 コードの例
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 で表示
Perl google-ads-perl tar.gz、zip GitHub で表示

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

以下の表に、利用可能な各 API バージョンをサポートする具体的なライブラリ バージョンを示します。

Java

API とサポート対象の Java の最小/最大バージョン
v11 Min:19.0.0
Max:
v10 Min:17.0.0
Max:
バージョン 9 Min:16.0.0
Max:19.0.0

C#

API とサポートされている最小/最大 .NET バージョン
v11 Min:12.1.0
Max:
v10 Min:11.0.0
Max:
バージョン 9 Min:10.2.0
Max:12.1.0

PHP

API とサポート対象の最小/最大 PHP バージョン
v11 Min:15.1.0
Max:
v10 Min:14.0.0
Max:
バージョン 9 Min:12.1.0
Max:15.1.0

Python

API とサポート対象の Python の最小/最大バージョン
v11 Min:17.0.0
Max:
v10 Min:15.0.0
Max:
バージョン 9 Min:14.1.0
Max:17.0.0

Ruby

API およびサポート対象の最小/最大 Ruby バージョン
v11 Min:18.0.0
Max:
v10 Min:16.0.0
Max:
バージョン 9 Min: 15.0.0
Max:18.0.0

Perl

API とサポート対象の最小/最大バージョン
v11 Min:12.0.0
Max:
v10 Min:10.0.0
Max:
バージョン 9 Min:9.2.0
Max:12.0.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 に設定します。ハイフン(-)なしで設定する必要があります。リンクされたアカウントについて詳しくは、ヘルプセンターをご覧ください。