Konfiguration

Die Bibliothek sucht in System.getProperty("user.home") + "/ads.properties" nach einer Konfigurationsdatei. Sie können diesen Pfad und Dateinamen bei der Laufzeit beim Erstellen des GoogleAdsClient mit einem der folgenden Mechanismen überschreiben:

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

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

Unterstützte Schlüssel für Desktop- und Webanwendungsflüsse

Wenn du die Desktop- oder Webanwendung verwendest, sind folgende Tasten 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

Unterstützte Schlüssel für Dienstkonten

Wenn Sie den Workflow für Dienstkonten verwenden, sind folgende 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 Umgebungsvariablen, die für alle Google Ads API-Clientbibliotheken gemeinsam sind. In der folgenden Tabelle sind die Umgebungsvariablen aufgeführt, die den einzelnen Konfigurationsdateieigenschaften entsprechen.

Konfigurationsdateiattribut 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

Nachdem Sie die entsprechenden Umgebungsvariablen festgelegt haben, konfigurieren Sie GoogleAdsClient, indem Sie fromEnvironment() auf dem Builder aufrufen.

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

Konfigurationsansätze kombinieren

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

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

In diesem Beispiel verwendet die Clientbibliothek den Wert aus der Properties-Datei für alle Attribute, die sowohl über die Umgebungsvariable als auch über einen Eintrag in der Properties-Datei definiert sind. Wenn Sie das Gegenteil erreichen möchten, 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.