Konfiguration

Es gibt verschiedene Möglichkeiten, den Client zu 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 in unserem 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. Am einfachsten erstellen Sie diese Datei, indem Sie das Beispiel google-ads.yaml aus dem GitHub-Repository kopieren und Ihre Anmeldedaten einfügen, einschließlich Entwicklertoken, Aktualisierungstoken, Client-ID und Client-Secret.

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 google-ads.yaml-Datei 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

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

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

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, aber in Großbuchstaben geschrieben und mit dem Namespace GOOGLE_ADS_ versehen werden. client_id sollte beispielsweise als GOOGLE_ADS_CLIENT_ID gespeichert werden.

Umgebungsvariablen werden in der Regel in einer Bash-Konfigurationsdatei wie .bashrc oder .bash_profile definiert, die sich im Verzeichnis $HOME befindet. Sie können auch über die Befehlszeile definiert werden. Bei dieser Anleitung wird davon ausgegangen, dass Sie bash verwenden. Wenn Sie eine andere Shell verwenden, müssen Sie möglicherweise in der Dokumentation nachlesen, wie Sie Umgebungsvariablen in der von Ihnen verwendeten Shell festlegen.

Hier sind einige grundlegende Schritte zum Definieren einer Umgebungsvariablen mit einer .bashrc-Datei über ein 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.
$ src ~/.bashrc

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

$ export GOOGLE_ADS_CLIENT_ID=1234567890
$ echo $GOOGLE_ADS_CLIENT_ID
1234567890

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 dafür, wie Sie eine Clientinstanz mit Konfiguration aus Umgebungsvariablen initialisieren:

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 sehen Sie 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"
    }
  }
}'

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 einfach die Methode load_from_string.

from google.ads.googleads.client import GoogleAdsClient

with open("/path/to/yaml", "rb") as handle:
    yaml = handle.read()

client = GoogleAdsClient.load_from_string(yaml)

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 = {
    "developer_token": "abcdef123456",
    "refresh_token": "1//0abcdefghijklABCDEF",
    "client_id": "123456-abcdef.apps.googleusercontent.com",
    "client_secret": "aBcDeFgHiJkL"}

client = GoogleAdsClient.load_from_dict(credentials)

Konfigurationsfelder

Die Clientbibliothekskonfiguration unterstützt die folgenden Felder.

Authentifizierung

Verwenden Sie nur eine dieser Gruppen von Feldern, 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.
  • 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 privaten Schlüsseldatei. Dies wird für die Authentifizierung mit einem Dienstkonto verwendet.

Verhalten der Mediathek

Diese Felder bestimmen das Verhalten der Bibliothek:

  • logging: Weitere Informationen finden Sie unter Logging-Konfiguration.
  • http_proxy: Weitere Informationen finden Sie in der Proxy-Dokumentation.
  • use_proto_plus: Gibt an, ob Proto-Plus-Nachrichten 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_CLIENT_ID
  • GOOGLE_ADS_CLIENT_SECRET
  • GOOGLE_ADS_CONFIGURATION_FILE_PATH
  • GOOGLE_ADS_DEVELOPER_TOKEN
  • GOOGLE_ADS_HTTP_PROXY
  • 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

Logging-Konfiguration

Die Protokollierungsfelder, 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 in der Logging-Anleitung.

  • 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, einschließlich eines Handlers und einer Log-Ebene.