Die Python-Clientbibliothek wird auf GitHub gehostet und das Paket ist auf PyPI verfügbar.
Voraussetzungen
Für die Bibliothek ist Python 3.8 oder höher erforderlich.
Vorbereitung
Bevor du die Bibliothek installieren kannst, benötigst du ein Entwicklertoken und die Kunden-ID des Kunden. Eine Anleitung zum Abrufen finden Sie im Abschnitt Voraussetzungen. Die anderen erforderlichen OAuth2-Tokens werden in späteren Schritten generiert.
Laufzeit- und Abhängigkeitskompatibilität
Die Python-Clientbibliothek ist mit den Python-Laufzeiten im Abschnitt Unterstützte Versionen der Python Software Foundation kompatibel, mit Ausnahme von Versionen mit dem Status „Funktion“ oder „Vorabversion“.
Bei der Einführung neuer Versionen der Python-Laufzeit möchten wir bis Ende des Quartals nach der Veröffentlichung eine neue Version der Python-Clientbibliothek veröffentlichen, die mit der neuesten Laufzeit kompatibel ist. Wenn beispielsweise im Oktober eine neue Laufzeit veröffentlicht wird, ist bis Ende März des Folgejahres eine kompatible Version der Python-Clientbibliothek verfügbar.
Python-Laufzeiten, die das End of Life (EOL) erreicht haben, werden nach dem End of Life-Datum im Abschnitt Nicht unterstützte Versionen von python.org nicht mehr unterstützt.
Wir können irgendwann nach Erreichen des EOL eine Version der Python-Clientbibliothek veröffentlichen, die mit nicht unterstützten Python-Laufzeiten nicht kompatibel ist.
Bei Abhängigkeiten (insbesondere bei von Google gepflegten Paketen, die von der Python-Clientbibliothek als erforderlich aufgeführt sind) wird die Kompatibilität mit von Google gepflegten Paketen aufrechterhalten, die gemäß der Richtlinie zu OSS-Bruchänderungen von Google als „unterstützt“ eingestuft werden.
Eine vollständige Liste der unterstützten Python-Laufzeiten und ‑Abhängigkeiten finden Sie auf der Seite Abhängigkeiten.
Installation
Folgen Sie der Anleitung in unserer Installationsdokumentation, um die Bibliothek aus PyPi zu installieren und zu dieser Seite zurückzukehren.
Konfiguration
Nachdem Sie die Bibliothek installiert haben, müssen Sie eine Konfiguration dafür einrichten. Es gibt mehrere Möglichkeiten, die Bibliothek zu konfigurieren. Eine entsprechende Anleitung finden Sie in der Konfigurationsdokumentation.
Authentifizierung
Nachdem Sie einen Konfigurationstyp ausgewählt haben, können Sie mit dem Generieren der verbleibenden OAuth2-Tokens fortfahren, die für Anfragen an die API erforderlich sind. Es gibt mehrere unterstützte OAuth2-Abläufe, die in der folgenden Liste beschrieben sind. Weitere Informationen zu den Unterschieden zwischen den Abläufen und zur Auswahl der besten Variante für Ihre Anwendung finden Sie in unserer OAuth.
API-Anfrage stellen
Nachdem du deine OAuth2-Token in die Konfiguration aufgenommen hast, kannst du eine API-Anfrage senden. Das Beispiel get campaigns bietet eine einfache Möglichkeit zu testen, ob die Bibliothek ordnungsgemäß für API-Anfragen konfiguriert ist.
Führen Sie zum Ausführen des get_campaigns.py-Beispiels im Stammverzeichnis der lokal installierten googleads-python-Clientbibliothek den folgenden Befehl aus:
$ python examples/basic_operations/get_campaigns.py -c \
INSERT_YOUR_CUSTOMER_ID_HERE
Zusätzliche Ressourcen
Nachdem Sie eine API-Anfrage senden können, können Sie die Clientbibliothek für folgende Zwecke verwenden: