Konfiguration

Sie können die Python-Clientbibliothek mit einer YAML-Datei, Umgebungsvariablen, einem YAML-String oder einem dict konfigurieren.

Authentifizierungskonfiguration

Es gibt mehrere Möglichkeiten, die für den Zugriff auf die Google Ads API erforderlichen OAuth-Anmeldedaten zu verwalten. Die von Ihnen gewählte Methode wirkt sich darauf aus, welche Konfigurationsfelder Sie verwenden. Weitere Informationen finden Sie im Authentifizierungsleitfaden.

Konfiguration über YAML-Datei

Sie können eine YAML-Datei angeben, die beim Initialisieren des Clients verwendet werden soll und die die erforderlichen Informationen für Anfragen an die Google Ads API enthält. Auf diese Datei wird zugegriffen, wenn ein Client mit der Methode load_from_storage initialisiert wird. Die einfachste Möglichkeit, diese Datei zu generieren, besteht darin, das google-ads.yaml-Beispiel aus dem GitHub-Repository zu kopieren und es so zu ändern, dass es Ihre Anmeldedaten enthält, einschließlich Ihres Aktualisierungstokens, Ihrer Client-ID und Ihres Client-Secrets.

Wenn Sie keinen Pfad angeben, sucht die Bibliothek im Verzeichnis $HOME nach der Datei:

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage()

Wenn Sie einen Speicherort für die Datei google-ads.yaml angeben möchten, können Sie den Pfad als String an die Methode übergeben, wenn Sie sie aufrufen:

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_storage("path/to/google-ads.yaml")

Sie können den Pfad auch angeben, indem Sie eine bestimmte Umgebungsvariable definieren:

import os
from google.ads.googleads.client import GoogleAdsClient

os.environ["GOOGLE_ADS_CONFIGURATION_FILE_PATH"] = "path/to/google-ads.yaml"
client = GoogleAdsClient.load_from_storage()

Wenn beide Werte angegeben sind – ein Pfad wird an die Methode übergeben und die Umgebungsvariable ist vorhanden –, priorisiert die Bibliothek den an die Methode übergebenen Pfad.

Konfiguration über Umgebungsvariablen

Sie können die gesamte Clientkonfiguration als Umgebungsvariablen speichern, die beim Aufrufen der load_from_env-Methode des Clients gelesen werden. Umgebungsvariablen sollten denselben Namen wie die in der Datei google-ads.yaml definierten Variablen haben, müssen aber in Großbuchstaben geschrieben und mit dem Namespace GOOGLE_ADS_ versehen werden. Beispiel: client_id sollte als GOOGLE_ADS_CLIENT_ID gespeichert werden.

Umgebungsvariablen werden in der Regel in einer Bash-Konfigurationsdatei wie einer .bashrc- oder .bash_profile-Datei im Verzeichnis $HOME definiert. Sie können auch über die Befehlszeile definiert werden.

Hier sind einige grundlegende Schritte zum Definieren einer Umgebungsvariable mit einer .bashrc-Datei in einem Terminal:

# Append the line "export GOOGLE_ADS_CLIENT_ID=1234567890" to
# the bottom of your .bashrc file.
echo "export GOOGLE_ADS_CLIENT_ID=1234567890" >> ~/.bashrc
# Update your bash environment to use the most recently updated
# version of your .bashrc file.
source ~/.bashrc

Umgebungsvariablen können auch direkt über die Befehlszeile in Ihrer Terminalinstanz festgelegt werden:

export GOOGLE_ADS_CLIENT_ID=1234567890
echo $GOOGLE_ADS_CLIENT_ID

Mit der Methode load_from_env werden Konfigurationsdaten aus dem Attribut environ des integrierten os-Moduls von Python geladen. Beispiel: os.environ["GOOGLE_ADS_CLIENT_ID"]

Hier sehen Sie ein Beispiel für die Initialisierung einer Clientinstanz mit Konfiguration aus Umgebungsvariablen:

from google.ads.googleads.client import GoogleAdsClient

client = GoogleAdsClient.load_from_env()

Wenn Sie logging über Umgebungsvariablen konfigurieren möchten, muss der Konfigurationswert ein JSON-Objekt sein, das der Struktur der YAML-Schlüssel in der Beispielkonfigurationsdatei google-ads.yaml entspricht.

Hier ist ein Beispiel dafür, wie dies mit einer .bashrc-Datei festgelegt werden kann:

export GOOGLE_ADS_LOGGING='{
  "version": 1,
  "disable_existing_loggers": false,
  "formatters": {
    "default_fmt": {
      "format": "[%(asctime)s - %(levelname)s] %(message).5000s",
      "datefmt": "%Y-%m-%d %H:%M:%S"
    }
  },
  "handlers": {
    "default_handler": {
      "class": "logging.StreamHandler",
      "formatter": "default_fmt"
    }
  },
  "loggers": {
    "": {
      "handlers": ["default_handler"],
      "level": "INFO"
    }
  }
}'

Wichtig: Wenn die Umgebungsvariable GOOGLE_ADS_CONFIGURATION_FILE_PATH festgelegt ist, wenn die Methode load_from_env aufgerufen wird, werden Konfigurationswerte aus der Datei google-ads.yaml abgerufen, die sich am angegebenen Pfad befindet, und nicht aus den zuvor beschriebenen Umgebungsvariablen.

Konfiguration mit einem YAML-String

Wenn Sie eine YAML-Datei in den Arbeitsspeicher gelesen haben, können Sie sie bei der Initialisierung direkt an den Client übergeben. Verwenden Sie dazu die Methode load_from_string:

from google.ads.googleads.client import GoogleAdsClient

with open("/path/to/yaml", "r", encoding="utf-8") as handle:
    yaml_content = handle.read()

client = GoogleAdsClient.load_from_string(yaml_content)

Konfiguration mit einem dict

Sie können ein dict direkt an die Methode load_from_dict übergeben. Beispiel:

from google.ads.googleads.client import GoogleAdsClient

credentials = {
    "refresh_token": "YOUR_REFRESH_TOKEN",
    "client_id": "YOUR_CLIENT_ID",
    "client_secret": "YOUR_CLIENT_SECRET",
    "use_proto_plus": True,
}

client = GoogleAdsClient.load_from_dict(credentials)

Felder für die Konfiguration

Die Clientbibliothekskonfiguration unterstützt die folgenden Felder.

Authentifizierung

Verwenden Sie nur eine dieser Feldgruppen, je nachdem, welchen Authentifizierungsansatz Sie verwenden:

  • Einzelnutzer mit Standardanmeldedaten für Anwendungen (Dokumentation)
    • use_application_default_credentials: Gibt an, ob die Bibliothek Standardanmeldedaten für Anwendungen (Application Default Credentials, ADC) für die Authentifizierung verwenden soll (wird in google-ads v28.3.0 und höher unterstützt).
  • Einzelnutzer mit OAuth-Tokens (Dokumentation)
    • client_id: Ihre OAuth-Client-ID.
    • client_secret: Ihr OAuth-Clientschlüssel.
    • refresh_token: Ihr OAuth-Aktualisierungstoken.
  • Dienstkonto (Dokumentation)
    • json_key_file_path: Ein Pfad zu einer lokalen Datei mit einem privaten Schlüssel. Dies wird für die Authentifizierung über ein Dienstkonto verwendet.
    • impersonated_email: Optionale E-Mail-Adresse des Kontos, dessen Identität übernommen werden soll, wenn die delegierte Autorisierung für die gesamte Google Workspace-Domain verwendet wird.

Verhalten der Bibliothek

Diese Felder bestimmen das Verhalten der Bibliothek:

  • logging: Weitere Informationen finden Sie unter Logkonfiguration.
  • http_proxy: Weitere Informationen finden Sie in der Proxy-Dokumentation.
  • use_proto_plus: Erforderlich. Ob Proto-Plus-Nachrichten (True oder False) verwendet werden sollen. Weitere Informationen finden Sie in der Dokumentation zu Protobuf-Nachrichten.

Konfiguration auf Anfrageebene

Umgebungsvariablen

So konfigurieren Sie die Bibliothek mit Umgebungsvariablen:

  • GOOGLE_ADS_ADS_ASSISTANT
  • GOOGLE_ADS_CLIENT_ID
  • GOOGLE_ADS_CLIENT_SECRET
  • GOOGLE_ADS_CONFIGURATION_FILE_PATH
  • GOOGLE_ADS_ENDPOINT
  • GOOGLE_ADS_HTTP_PROXY
  • GOOGLE_ADS_IMPERSONATED_EMAIL
  • GOOGLE_ADS_JSON_KEY_FILE_PATH
  • GOOGLE_ADS_LINKED_CUSTOMER_ID
  • GOOGLE_ADS_LOGIN_CUSTOMER_ID
  • GOOGLE_ADS_LOGGING
  • GOOGLE_ADS_REFRESH_TOKEN
  • GOOGLE_ADS_USE_PROTO_PLUS
  • GOOGLE_ADS_USE_APPLICATION_DEFAULT_CREDENTIALS (ab v28.3.0 unterstützt)

Logkonfiguration

Logfelder, die Felder unter dem Konfigurationsfeld logging sind, werden direkt aus dem integrierten Modul logging.config abgeleitet, da die Bibliothek alle Felder unter dem Namespace logging direkt an die Methode logging.config.dictConfig übergibt. Ausführliche Informationen finden Sie im Leitfaden zum Logging.

  • version: Ein ganzzahliger Wert, der eine Schemaversion darstellt.
  • disable_existing_loggers: Gibt an, ob Logger, die an anderer Stelle in der Anwendung konfiguriert sind, deaktiviert werden sollen.
  • formatters: Wörterbücher, die verschiedene Arten von Formatierungen definieren.
  • handlers: Wörterbücher, die verschiedene Handler definieren, die steuern, wohin Protokolle geschrieben werden und welche Formatierer verwendet werden sollen.
  • loggers: Wörterbücher, die verschiedene Arten von Loggern definieren, darunter ein Handler und eine Log-Ebene.