Konfiguration

Mit Sammlungen den Überblick behalten Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.

Die Bibliothek sucht in System.getProperty("user.home") + "/ads.properties" nach einer Konfigurationsdatei. Sie können diesen Pfad und den 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 Pfad und 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 das einer Java-Eigenschaftendatei mit Schlüssel/Wert-Paaren. Die unterstützten Schlüssel variieren je nach ausgewähltem Authentifizierungsablauf.

Unterstützte Abläufe für Desktop- und Webanwendungen

Wenn Sie den Anwendungsablauf Desktop oder Web 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 Vorgang Dienstkonto 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. In der folgenden Tabelle sehen Sie die Umgebungsvariable, die dem Attribut der Konfigurationsdatei entspricht.

Eigenschaft 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 GoogleAdsClient, indem Sie fromEnvironment() im Builder aufrufen.

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

Konfigurationsansätze kombinieren

GoogleAdsClient und sein Builder unterstützen die Kombination verschiedener Konfigurationsstrategien. Sie können beispielsweise Umgebungsvariablen verwenden, um die Anmeldedaten der Instanz und eine Attributdatei für andere Attribute mit dem folgenden Snippet zu 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 durch seine Umgebungsvariable als auch durch einen Eintrag in der Attributdatei definiert ist. Für das Gegenteil können Sie einfach fromPropertiesFile() vor fromEnvironment() aufrufen.

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

Konfigurationsdateien aus der AdWords API-Clientbibliothek für Java wiederverwenden

Sie können dieselbe ads.properties-Datei verwenden, die Sie für die AdWords API verwendet haben. Kopieren Sie einfach die Zeilen für die folgenden Schlüssel und ändern Sie das Präfix api.adwords in jedem Schlüssel von api.adwords in api.googleads:

api.adwords.developerToken     --> api.googleads.developerToken
# For desktop or web OAuth credentials:
api.adwords.clientId           --> api.googleads.clientId
api.adwords.clientSecret       --> api.googleads.clientSecret
api.adwords.refreshToken       --> api.googleads.refreshToken
# For service account OAuth credentials:
api.adwords.jsonKeyFilePath    --> api.googleads.serviceAccountSecretsPath
api.adwords.serviceAccountUser --> api.googleads.serviceAccountUser

Wenn Sie sich als Verwaltungskonto authentifizieren, müssen Sie außerdem Folgendes angeben:

api.googleads.loginCustomerId --> Manager account ID (with hyphens removed).