Konfiguration

Die Bibliothek sucht nach einer Konfigurationsdatei unter System.getProperty("user.home") + "/ads.properties". Sie können diesen Pfad und Dateinamen zur Laufzeit überschreiben, wenn Sie GoogleAdsClient mit einer der folgenden Methoden erstellen:

  • Rufen Sie fromPropertiesFile(PATH_TO_CONFIG_FILE) auf. PATH_TO_CONFIG_FILE ist der Pfad und Dateiname Ihrer Konfigurationsdatei.
  • Legen Sie die Umgebungsvariable GOOGLE_ADS_CONFIGURATION_FILE_PATH auf den Pfad und Dateinamen Ihrer Konfigurationsdatei fest und rufen Sie dann fromPropertiesFile() auf.

Das Format der Konfigurationsdatei entspricht dem einer Java Attributdatei mit Schlüssel/Wert-Paaren. Die unterstützten Schlüssel variieren je nach ausgewähltem Authentifizierungsablauf.

Unterstützte Schlüssel für Desktop- und Webanwendungsabläufe

Wenn Sie den Ablauf für Einzelnutzeranwendungen oder Mehrere Nutzer verwenden, sind die folgenden Schlüssel unterstützt:

# 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

# Specifies whether to use application default credentials.
api.googleads.useApplicationDefaultCredentials=false

Unterstützte Schlüssel für Dienstkonten

Wenn Sie den Dienstkonto ablauf verwenden, sind die folgenden Schlüssel unterstützt:

# 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

Umgebungsvariablen verwenden

Die Bibliothek unterstützt alle der Umgebungsvariablen, die für alle Google Ads API Clientbibliotheken üblich sind. In der folgenden Tabelle sehen Sie die Umgebungsvariable, die der jeweiligen Konfigurationsdatei-Eigenschaft entspricht.

Konfigurationsdatei-Eigenschaft Umgebungsvariable
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
api.googleads.useApplicationDefaultCredentials GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS

Nachdem Sie die entsprechenden Umgebungsvariablen festgelegt haben, konfigurieren Sie GoogleAdsClient, indem Sie fromEnvironment() für den Builder aufrufen.

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

Konfigurationsansätze kombinieren

Der GoogleAdsClient und sein Builder unterstützen die Kombination verschiedener Konfigurationsstrategien. Mit dem folgenden Snippet können Sie beispielsweise Umgebungsvariablen verwenden, um die Anmeldedaten der Instanz zu konfigurieren, und eine Attributdatei für andere Attribute.

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

In diesem Beispiel verwendet die Clientbibliothek den Wert aus der Attributdatei für alle Attribute, die sowohl über ihre Umgebungsvariable als auch über einen Eintrag in der Attributdatei definiert sind. Wenn Sie das umgekehrte Verhalten wünschen, rufen Sie einfach fromPropertiesFile() vor fromEnvironment() auf.

Sie können weitere Änderungen zur Laufzeit mit den anderen Konfigurationsmethoden des Builders vornehmen, bevor Sie build() aufrufen.