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 Sie die Bibliothek installieren, benötigen Sie ein Entwicklertoken und eine Client-Kundennummer. Eine Anleitung dazu 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 kompatibel, der von der Python Software Foundation veröffentlicht wird. Ausgenommen sind Versionen mit dem Status „feature“ oder „prerelease“.
Wenn wir neue Versionen der Python-Laufzeit einführen, veröffentlichen wir in der Regel bis zum Ende des Quartals nach der Veröffentlichung der neuen Laufzeit eine neue Version der Python-Clientbibliothek, die mit der neuesten Laufzeit kompatibel ist. Wenn beispielsweise im Oktober eine neue Laufzeitumgebung veröffentlicht wird, ist bis Ende März des folgenden Jahres eine kompatible Version der Python-Clientbibliothek verfügbar.
Python-Laufzeiten, die das End of Life (EOL) erreicht haben, werden nach dem EOL-Datum im Abschnitt Unsupported Versions (Nicht unterstützte Versionen) auf python.org nicht mehr unterstützt.
Wir können jederzeit nach dem EOL eine Version der Python-Clientbibliothek veröffentlichen, die mit nicht unterstützten Python-Laufzeiten inkompatibel ist.
Bei Abhängigkeiten, insbesondere bei allen von Google verwalteten Paketen, die von der Python-Clientbibliothek als erforderlich aufgeführt werden, sorgen wir für Kompatibilität mit Paketen, die von Google verwaltet werden und gemäß der OSS Breaking Change Policy von Google als „unterstützt“ gelten.
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 über PyPi zu installieren, und kehren Sie dann zu dieser Seite zurück.
Konfiguration
Nach der Installation der Bibliothek müssen Sie eine Konfiguration dafür einrichten. Es gibt mehrere Möglichkeiten, die Bibliothek zu konfigurieren. Diese werden in unserer Konfigurationsdokumentation beschrieben.
Authentifizierung
Nachdem Sie einen Konfigurationstyp ausgewählt haben, können Sie die verbleibenden OAuth2-Tokens generieren, die für Anfragen an die API erforderlich sind. Es gibt mehrere unterstützte OAuth2-Abläufe, die in der folgenden Liste dokumentiert sind. Weitere Informationen zu den Unterschieden zwischen den Abläufen und zur Entscheidung, welcher für Ihre Anwendung am besten geeignet ist, finden Sie in unserer OAuth.
API-Anfrage stellen
Nachdem Sie Ihre OAuth2-Tokens in Ihre Konfiguration aufgenommen haben, können Sie eine API-Anfrage stellen. Im Beispiel für „get campaigns“ finden Sie eine einfache Möglichkeit, zu testen, ob die Bibliothek richtig konfiguriert ist, um API-Anfragen zu stellen.
Führen Sie zum Ausführen des get_campaigns.py-Beispiels im Stammverzeichnis Ihrer 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 stellen können, fahren Sie mit den folgenden Anwendungsfällen der Clientbibliothek fort: