構成

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

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

  • fromPropertiesFile(PATH_TO_CONFIG_FILE) を呼び出します。ここで、PATH_TO_CONFIG_FILE は構成ファイルのパスとファイル名です。
  • 環境変数 GOOGLE_ADS_CONFIGURATION_FILE_PATH に構成ファイルのパスとファイル名を設定し、fromPropertiesFile() を呼び出します。

構成ファイルの形式は、Key-Value ペアの Java プロパティ ファイルの形式です。サポートされる鍵は、選択した認証フローによって異なります。

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

デスクトップまたはウェブのアプリケーション フローを使用している場合、サポートされるキーは次のとおりです。

# 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

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

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

# 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

適切な環境変数を設定したら、ビルダーで fromEnvironment() を呼び出して GoogleAdsClient を構成します。

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

構成方法の併用

GoogleAdsClient とそのビルダーでは、さまざまな構成戦略を組み合わせることができます。たとえば、次のスニペットを使用して、環境変数を使用してインスタンスの認証情報と他の属性のプロパティ ファイルを構成できます。

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

この例では、クライアント ライブラリは、環境変数とプロパティ ファイル内のエントリの両方によって定義されている属性に対して、プロパティ ファイルの値を使用します。逆の動作を行うには、fromEnvironment() の前に fromPropertiesFile() を呼び出します。

build() を呼び出す前に、ビルダーの他の構成方法を使用して、実行時にさらに変更を加えることができます。

Java 用 AdWords API クライアント ライブラリの設定ファイルを再利用する

AdWords API と同じ ads.properties ファイルを使用できます。次のキーの行をコピーして、各キーの api.adwords プレフィックスを api.adwords から api.googleads に変更します。

api.adwords.developerToken     --> api.googleads.developerToken
# For desktop or web OAuth credentials:
api.adwords.clientId           --> api.googleads.clientId
api.adwords.clientSecret       --> api.googleads.clientSecret
api.adwords.refreshToken       --> api.googleads.refreshToken
# For service account OAuth credentials:
api.adwords.jsonKeyFilePath    --> api.googleads.serviceAccountSecretsPath
api.adwords.serviceAccountUser --> api.googleads.serviceAccountUser

クライアント センター(MCC)アカウントとして認証する場合は、さらに次の情報を指定する必要があります。

api.googleads.loginCustomerId --> Manager account ID (with hyphens removed).