Data Portability API mit einem Python-Skript aufrufen

In dieser Kurzanleitung erhalten Sie ein OAuth-Token für Ihr Konto und senden Anfragen mit einem Python-Skript an die Data Portability API-Endpunkte.

Lerninhalte

In dieser Kurzanleitung verwenden Sie ein Python-Skript für folgende Zwecke:

  • Durch Angabe eines gültigen OAuth-Tokens senden Sie eine authentifizierte Anfrage an den Endpunkt InitiatePortabilityArchive. Die Antwort ist ein gültiger job_id.
  • Senden Sie eine authentifizierte Anfrage an den Endpunkt GetPortabilityArchiveState und laden Sie die Daten herunter. Die Antwort sollte einen gültigen Jobstatus und nach Abschluss des Jobs eine signierte URL enthalten.
  • Senden Sie eine authentifizierte Anfrage an den Endpunkt ResetAuthorization. Mit dieser Anfrage werden alle vom Nutzer gewährten OAuth-Bereiche widerrufen.

Voraussetzungen

So führen Sie diese Kurzanleitung aus:

  • Prüfen Sie, ob die Data Portability API für Sie verfügbar ist. Eine Liste der unterstützten Länder und Regionen finden Sie unter Häufig gestellte Fragen auf der Seite „Kopie Ihrer Daten mit Drittanbietern teilen“.
  • Führen Sie die Einrichtungsschritte für die Data Portability API aus und prüfen Sie, ob Sie ein neues Projekt verwenden.
  • Zugriff auf ein Konto erhalten, das Ihrer Organisation gehört oder von dieser kontrolliert wird. Die Daten zu den Suchaktivitäten dieses Kontos werden in dieser Kurzanleitung exportiert.

Bevor Sie mit dieser Kurzanleitung beginnen, müssen Sie auch OAuth, Python und das OAuth-Paket für die Python-Clientbibliotheken einrichten.

OAuth einrichten

  • Konfigurieren Sie OAuth für installierte Anwendungen. Dieser Ablauf ähnelt dem OAuth-Ablauf für Webserveranwendungen. Beim Konfigurieren der OAuth-Client-ID gilt Folgendes:
    • Der Anwendungstyp sollte Desktopanwendung sein.
    • Nachdem Sie die Client-ID erstellt haben, laden Sie den Clientschlüssel im JSON-Format herunter und geben Sie der Datei den Namen client_secrets.json.
    • Wenn Sie für die Data Portability API Bereiche konfigurieren, beachten Sie, dass in dieser Kurzanleitung die folgenden Ressourcengruppen verwendet werden:

Python einrichten

Sie müssen Python auf Ihrem lokalen Computer einrichten, um das in dieser Kurzanleitung verwendete Skript auszuführen. So richten Sie Python ein:

  • Installieren Sie das Pip-Paketverwaltungstool und Python 3.9 (oder höher).
  • Installieren Sie die Google-API-Clientbibliothek für Python.
  • Installieren Sie mit diesem Befehl das Paket google_auth_oauthlib für die Python-Clientbibliothek. Dieses Paket bietet die oauthlib-Integration in google-auth, der Google-Authentifizierungsbibliothek für Python.

    pip install google-auth-oauthlib google-api-python-client --upgrade
    

Skript ausführen

Dieses Skript verwendet im OAuth-Ablauf eine Weiterleitung auf einen lokalen Host. Für diese Option muss die Anwendung einen Localhost-Port überwachen und dann den Systembrowser öffnen, um den OAuth-Autorisierungsablauf zu starten.

Klicken Sie auf diesen Link, um das Skript zu öffnen, oder laden Sie eine Kopie des Skripts herunter, indem Sie mit der rechten Maustaste auf den Link klicken.

Python-Kurzanleitungsskript für die Data Portability API

Geben Sie den folgenden Befehl ein, um das Skript auszuführen:

python3 data-portability-quickstart.py

Die vom Skript ausgeführten Aktionen sind in den Kommentaren ausführlich beschrieben.