設定

ライブラリは、 System.getProperty("user.home") + "/ads.properties"。この設定は を使用して GoogleAdsClient を作成するときに、実行時のパスとファイル名を指定します。 次のメカニズムのいずれかで行われます。

  • fromPropertiesFile(PATH_TO_CONFIG_FILE)（PATH_TO_CONFIG_FILE）に発信します 構成ファイルのパスとファイル名です。
  • 環境変数 GOOGLE_ADS_CONFIGURATION_FILE_PATH を 構成ファイルのパスとファイル名を指定し、 fromPropertiesFile()。

構成ファイルの形式は、Java の プロパティ Key-Value ペアを格納したファイルですサポートされるキーは、選択した 認証フローについて説明します。

デスクトップ アプリケーションとウェブ アプリケーション フローでサポートされるキー

パソコンまたは web アプリケーション フロー、サポートされているキー 次のとおりです。

# Credential for accessing Google's OAuth servers.
# Provided by console.cloud.google.com.
api.googleads.clientId=INSERT_CLIENT_ID_HERE

# Credential for accessing Google's OAuth servers.
# Provided by console.cloud.google.com.
api.googleads.clientSecret=INSERT_CLIENT_SECRET_HERE

# Renewable OAuth credential associated with 1 or more Google Ads accounts.
api.googleads.refreshToken=INSERT_REFRESH_TOKEN_HERE

# Token which provides access to the Google Ads API in general. It does not
# grant access to any particular ad account (OAuth is used for this purpose).
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE

# Required for manager accounts only: Specify the login customer ID used to
# authenticate API calls. This will be the customer ID of the authenticated
# manager account. You can also specify this later in code if your application
# uses multiple manager account + OAuth pairs.
#
# api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

# Only required if explicitly instructed by the service documentation.
# api.googleads.linkedCustomerId=INSERT_LINKED_CUSTOMER_ID_HERE

# Maximum allowed response payload size, in bytes.
# Customize this to allow response sizes for GoogleAdsService.search and
# GoogleAdsService.searchStream API calls to exceed the default limit of 64MB.
# api.googleads.maxInboundMessageBytes=INSERT_MAX_INBOUND_MESSAGE_BYTES_HERE

サービス アカウントでサポートされている鍵

サービス アカウントを使用している場合 サポートされているキーは次のとおりです。

# Path to the service account secrets file in JSON format.
# Provided by console.cloud.google.com.
api.googleads.serviceAccountSecretsPath=INSERT_PATH_TO_JSON_HERE

# Email address of the user to impersonate.
# This should be a user who has access to your Google Ads account and is in the same
# Google Apps Domain as the service account.
api.googleads.serviceAccountUser=INSERT_USER_EMAIL_ADDRESS_HERE

# Token which provides access to the Google Ads API in general. It does not
# grant access to any particular ad account (OAuth is used for this purpose).
api.googleads.developerToken=INSERT_DEVELOPER_TOKEN_HERE

# Required for manager accounts only: Specify the login customer ID used to
# authenticate API calls. This will be the customer ID of the authenticated
# manager account. You can also specify this later in code if your application
# uses multiple manager account + OAuth pairs.
#
# api.googleads.loginCustomerId=INSERT_LOGIN_CUSTOMER_ID_HERE

環境変数の使用

このライブラリでは、すべての Google Ads API に共通する環境変数がすべてサポートされています。 クライアント ライブラリをご覧ください。以下の表に 環境変数を定義します。

構成ファイルのプロパティ 環境変数
api.googleads.developerToken GOOGLE_ADS_DEVELOPER_TOKEN
api.googleads.clientId GOOGLE_ADS_CLIENT_ID
api.googleads.clientSecret GOOGLE_ADS_CLIENT_SECRET
api.googleads.refreshToken GOOGLE_ADS_REFRESH_TOKEN
api.googleads.serviceAccountSecretsPath GOOGLE_ADS_JSON_KEY_FILE_PATH
api.googleads.serviceAccountUser GOOGLE_ADS_IMPERSONATED_EMAIL
api.googleads.loginCustomerId GOOGLE_ADS_LOGIN_CUSTOMER_ID
api.googleads.linkedCustomerId GOOGLE_ADS_LINKED_CUSTOMER_ID
api.googleads.maxInboundMessageBytes GOOGLE_ADS_MAX_INBOUND_MESSAGE_BYTES

適切な環境変数を設定したら、アプリケーションの ビルダーで fromEnvironment() を呼び出して GoogleAdsClient します。

GoogleAdsClient googleAdsClient = GoogleAdsClient.newBuilder()
  .fromEnvironment()
  .build();

構成アプローチの組み合わせ

GoogleAdsClient とそのビルダーは、異なる構成の組み合わせをサポートします。 説明します。たとえば、環境変数を使用してサービス アカウントを 使用して他の属性のプロパティ ファイルを指定し、 次のスニペットを使用します。

GoogleAdsClient googleAdsClient = GoogleAdsClient.newBuilder()
    .fromEnvironment()
    .fromPropertiesFile()
    .build();

この例では、クライアント ライブラリはプロパティ ファイルの値を使用します。 環境変数と エントリを宣言します。逆に動作する場合は、単に fromEnvironment()までに fromPropertiesFile()。

ビルダーの他の構成を使用して、実行時にさらに変更を加えることができます メソッドを build() の呼び出し前に追加する必要があります。