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

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

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

Формат файла конфигурации соответствует файлу свойств 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

# 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

Использование переменных окружения

Библиотека поддерживает все переменные среды, общие для всех клиентских библиотек API Google Ads . В таблице ниже показаны переменные среды, соответствующие каждому свойству файла конфигурации.

Свойство файла конфигурации	Переменная окружения
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

После установки соответствующих переменных среды настройте GoogleAdsClient , вызвав fromEnvironment() в конструкторе.

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

Комбинирование подходов к конфигурации

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

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

В этом примере клиентская библиотека будет использовать значение из файла свойств для любого атрибута, определённого как через переменную окружения, так и через запись в файле свойств. Для обратного поведения просто вызовите fromPropertiesFile() перед fromEnvironment() .

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