Konfiguration

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

  • fromPropertiesFile(PATH_TO_CONFIG_FILE) anrufen, wobei 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 hinzu. Rufen Sie dann fromPropertiesFile().

Die Konfigurationsdatei hat das Format einer Java- Unterkünfte der Schlüssel/Wert-Paare. Die unterstützten Schlüssel variieren je nach ausgewähltem Authentifizierungsvorgangs.

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

Wenn Sie den Desktop oder Web-Anwendung, die unterstützten Schlüssel sind:

# 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 das 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 der Google Ads API üblich sind. Clientbibliotheken In der folgenden Tabelle sehen Sie die jedem Konfigurationsdateiattribut 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
api.googleads.maxInboundMessageBytes GOOGLE_ADS_MAX_INBOUND_MESSAGE_BYTES

Nachdem Sie die entsprechenden Umgebungsvariablen festgelegt haben, konfigurieren Sie Ihre GoogleAdsClient durch Aufrufen von fromEnvironment() im Builder.

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

Konfigurationsansätze kombinieren

GoogleAdsClient und sein Builder unterstützen die Kombination verschiedener Konfigurationen zu entwickeln. Mit Umgebungsvariablen können Sie z. B. den Parameter der Instanz und eine Eigenschaftendatei für andere Attribute mit das folgende Snippet einfügen.

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

In diesem Beispiel verwendet die Clientbibliothek den Wert aus der Eigenschaftendatei. für jedes Attribut, das sowohl über seine Umgebungsvariable als auch über ein in der Eigenschaftendatei. Um das Gegenteil zu verhindern, rufen Sie einfach fromPropertiesFile() vor dem fromEnvironment().

Sie können während der Laufzeit weitere Änderungen mit der anderen Konfiguration des Builders vornehmen. bevor Sie build() aufrufen.