Konfiguration

Die Bibliothek sucht in System.getProperty("user.home") + "/ads.properties" nach einer Konfigurationsdatei. 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, wobei PATH_TO_CONFIG_FILE der Pfad und Dateiname Ihrer Konfigurationsdatei ist.
Legen Sie die Umgebungsvariable GOOGLE_ADS_CONFIGURATION_FILE_PATH auf den Pfad und Dateinamen Ihrer Konfigurationsdatei fest und rufen Sie dann fromPropertiesFile() auf.

Die Konfigurationsdatei hat das Format einer Java-Eigenschaftendatei mit Schlüssel/Wert-Paaren. Welche Schlüssel unterstützt werden, hängt vom ausgewählten Authentifizierungsvorgang ab.

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

Wenn Sie den Ablauf für Desktop- oder Webanwendungen verwenden, werden folgende 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

Unterstützte Schlüssel für Dienstkonten

Wenn Sie den Dienstkonto-Ablauf verwenden, werden 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 in allen Google Ads API-Clientbibliotheken verwendet werden. Die folgende Tabelle zeigt die Umgebungsvariable, die den einzelnen Konfigurationsdateiattributen entspricht.

Attribut der Konfigurationsdatei	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`

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

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

Konfigurationsansätze kombinieren

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

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

In diesem Beispiel verwendet die Clientbibliothek den Wert aus der Attributdatei für jedes Attribut, das sowohl über die Umgebungsvariable als auch einen Eintrag in der Attributdatei definiert wird. Zum Gegenteil: Rufen Sie einfach fromPropertiesFile() vor fromEnvironment() auf.

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