Konfiguration

Die Java-Clientbibliothek sucht in Ihrem Basisverzeichnis (System.getProperty("user.home") + "/ads.properties" oder ~/ads.properties) nach einer Konfigurationsdatei mit dem Namen ads.properties. Sie können diesen Pfad und Dateinamen zur Laufzeit überschreiben, wenn Sie die GoogleAdsClient mit einem der folgenden Mechanismen erstellen:

  • Rufen Sie fromPropertiesFile(PATH_TO_CONFIG_FILE) auf, wobei PATH_TO_CONFIG_FILE der File-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 ist eine standardmäßige 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 Webanwendungsabläufe

Wenn Sie den Anwendungsablauf für einzelne Nutzer oder mehrere Nutzer verwenden, werden 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

# 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, werden 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

# 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

Umgebungsvariablen verwenden

Die Bibliothek unterstützt alle Standard-Umgebungsvariablen der Google Ads API-Clientbibliothek. In der folgenden Tabelle sind die Umgebungsvariablen aufgeführt, die den einzelnen Attributen der Konfigurationsdatei entsprechen:

Attribut der Konfigurationsdatei Umgebungsvariable
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() im Builder aufrufen:

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

Konfigurationsansätze kombinieren

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

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

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