Конфигурация

Клиентская библиотека Java ищет файл конфигурации с именем ads.properties в вашем домашнем каталоге (System.getProperty("user.home") + "/ads.properties" или ~/ads.properties). Вы можете переопределить этот путь и имя файла во время выполнения при создании GoogleAdsClient, используя любой из следующих механизмов:

  • Вызовите fromPropertiesFile(PATH_TO_CONFIG_FILE), где PATH_TO_CONFIG_FILE – это путь File и название файла конфигурации.
  • Задайте для переменной среды GOOGLE_ADS_CONFIGURATION_FILE_PATH путь и название файла конфигурации, а затем вызовите fromPropertiesFile().

Файл конфигурации представляет собой стандартный файл Properties 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

# 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

# Specifies whether to use Application Default Credentials.
api.googleads.useApplicationDefaultCredentials=false

Поддерживаемые ключи для сервисных аккаунтов

Если вы используете сервисный аккаунт, поддерживаются следующие ключи:

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

# Optional: Email address of the user to impersonate when using Google Workspace
# domain-wide delegation. This should be a user who has access to your Google Ads
# account and is in the same Google Workspace domain as the service account.
# api.googleads.serviceAccountUser=INSERT_USER_EMAIL_ADDRESS_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.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
api.googleads.useApplicationDefaultCredentials GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS

Задав переменные среды, настройте GoogleAdsClient, вызвав fromEnvironment() в построителе:

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

Как комбинировать разные подходы к настройке

GoogleAdsClient и его конструктор поддерживают сочетание разных стратегий конфигурации. Например, вы можете использовать переменные среды, чтобы настроить учетные данные экземпляра, и файл свойств для других атрибутов, используя следующий фрагмент кода:

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

Вы можете вносить дополнительные изменения во время выполнения, используя другие методы конфигурации конструктора, прежде чем вызывать build().