In den Kurzanleitungen wird erklärt, wie Sie eine App einrichten und ausführen, die eine Google Workspace API
In Google Workspace-Kurzanleitungen werden die API-Clientbibliotheken Details zum Authentifizierungs- und Autorisierungsvorgang. Wir empfehlen, Clientbibliotheken für Ihre eigenen Apps verwenden. In dieser Kurzanleitung wird ein vereinfachten Authentifizierungsansatz, der für Tests geeignet ist, zu verbessern. Für eine Produktionsumgebung empfehlen wir, sich über Authentifizierung und Autorisierung vorher Anmeldedaten auswählen die für Ihre App geeignet sind.
Erstellen Sie eine Python-Befehlszeilenanwendung, die Anfragen an die Google Docs API sendet.
Zielsetzungen
- die Umgebung einrichten
- Installieren Sie die Clientbibliothek.
- Richten Sie das Beispiel ein.
- Führen Sie das Beispiel aus.
Vorbereitung
Für diese Kurzanleitung sind die folgenden Voraussetzungen erforderlich:
- Python 3.10.7 oder höher
- Das pip-Element Paketverwaltungstool
- Ein Google Cloud-Projekt
- Ein Google-Konto.
Umgebung einrichten
Richten Sie Ihre Umgebung ein, um diese Kurzanleitung abzuschließen.
API aktivieren
Bevor Sie Google APIs verwenden können, müssen Sie sie in einem Google Cloud-Projekt aktivieren. Sie können eine oder mehrere APIs in einem einzelnen Google Cloud-Projekt aktivieren.Aktivieren Sie in der Google Cloud Console die Google Docs API.
OAuth-Zustimmungsbildschirm konfigurieren
Wenn Sie für diese Kurzanleitung ein neues Google Cloud-Projekt verwenden, konfigurieren Sie OAuth-Zustimmungsbildschirm öffnen und sich selbst als Testnutzer hinzufügen. Wenn Sie bereits Sie diesen Schritt für Ihr Cloud-Projekt abgeschlossen haben, fahren Sie mit dem nächsten Abschnitt fort.
- Öffnen Sie in der Google Cloud Console das Menü > APIs und Dienste > OAuth-Zustimmungsbildschirm. .
- Wählen Sie für Nutzertyp die Option Intern aus und klicken Sie dann auf Erstellen.
- Füllen Sie das App-Registrierungsformular aus und klicken Sie dann auf Speichern und fortfahren.
Vorerst können Sie das Hinzufügen von Bereichen überspringen und auf Speichern und fortfahren klicken. Wenn Sie in Zukunft eine App erstellen, die außerhalb Ihres Google Workspace-Organisation verwenden, müssen Sie den Nutzertyp in Extern ändern. fügen Sie die Autorisierungsbereiche hinzu, die Ihre Anwendung benötigt.
- Überprüfen Sie die Registrierungsübersicht der App. Wenn Sie Änderungen vornehmen möchten, klicken Sie auf Bearbeiten. Wenn die App mit der Registrierung in Ordnung ist, klicken Sie auf Zurück zum Dashboard.
Anmeldedaten für eine Desktopanwendung autorisieren
Für die Authentifizierung von Endnutzern und für den Zugriff auf Nutzerdaten in Ihrer Anwendung müssen Sie mindestens eine OAuth 2.0-Client-ID erstellen. Eine Client-ID wird zur Identifizierung einer einzelnen Anwendung bei Googles OAuth-Servern verwendet. Wenn Ihre App auf mehreren Plattformen läuft, müssen Sie für jede Plattform eine separate Client-ID erstellen.- Öffnen Sie in der Google Cloud Console das Dreistrich-Menü > APIs und Dienste > Anmeldedaten.
- Klicken Sie auf Anmeldedaten erstellen > OAuth-Client-ID.
- Klicken Sie auf Anwendungstyp > Desktop-App.
- Geben Sie in das Feld Name einen Namen für die Anmeldedaten ein. Dieser Name wird nur in der Google Cloud Console angezeigt.
- Klicken Sie auf Erstellen. Der Bildschirm "OAuth-Client erstellt" wird mit Ihrer neuen Client-ID und Ihrem Clientschlüssel angezeigt.
- Klicken Sie auf OK. Die neu erstellten Anmeldedaten werden unter OAuth 2.0-Client-IDs angezeigt.
- Speichern Sie die heruntergeladene JSON-Datei als
credentials.json
und verschieben Sie den in Ihr Arbeitsverzeichnis.
Google-Clientbibliothek installieren
Installieren Sie die Google-Clientbibliothek für Python:
pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib
Beispiel konfigurieren
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
quickstart.py
. Fügen Sie in
quickstart.py
den folgenden Code ein:
Beispiel ausführen
Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:
python3 quickstart.py
-
Wenn Sie das Beispiel zum ersten Mal ausführen, werden Sie aufgefordert, den Zugriff zu autorisieren:
- Wenn Sie noch nicht in Ihrem Google-Konto angemeldet sind, melden Sie sich an, wenn Sie dazu aufgefordert werden. Wenn Sie in mehreren Konten angemeldet sind, wählen Sie ein Konto für die Autorisierung aus.
- Klicken Sie auf Akzeptieren.
Ihre Python-Anwendung wird ausgeführt und ruft die Google Docs API auf.
Autorisierungsinformationen werden im Dateisystem gespeichert. Wenn Sie das Beispiel das nächste Mal ausführen, Code eingeben, werden Sie nicht zur Autorisierung aufgefordert.
Nächste Schritte
- Fehlerbehebung bei Authentifizierungs- und Autorisierungsproblemen
- Docs API-Referenzdokumentation
- Dokumentation zum Google APIs-Client für Python
- PyDoc-Dokumentation zur Google Docs API