In diesem Leitfaden wird beschrieben, wie eine Anwendung Anfragen an die User Deletion API autorisiert.
Anfragen autorisieren
Bevor Nutzer ihre Kontoinformationen auf der Google Analytics-Website abrufen können, müssen sie sich in ihren Google-Konten anmelden. Wenn Nutzer zum ersten Mal auf Ihre Anwendung zugreifen, müssen sie sie autorisieren, auf ihre Daten zuzugreifen.
Jede Anfrage, die Ihre Anwendung an die Analytics API sendet, muss ein Autorisierungstoken enthalten. Anhand dieses Tokens wird deine Anwendung Google gegenüber identifiziert.
Autorisierungsprotokolle
Ihre Anwendung muss zur Autorisierung von Anfragen OAuth 2.0 verwenden. Andere Autorisierungsprotokolle werden nicht unterstützt. Wenn deine Anwendung Über Google anmelden verwendet, werden einige Schritte der Autorisierung automatisch ausgeführt.
Anfragen mit OAuth 2.0 autorisieren
Alle Anfragen an die Analytics API müssen von einem authentifizierten Nutzer autorisiert werden.
Die Details dieses Autorisierungsablaufs für OAuth 2.0 hängen davon ab, welche Art von Anwendung du schreibst. Die folgende allgemeine Vorgehensweise gilt für alle Arten von Anwendungen:
- Wenn Sie Ihre Anwendung erstellen, registrieren Sie diese über die Google API Console. Google stellt Ihnen dann die Informationen bereit, die du später benötigst, z. B. eine Client-ID und einen Clientschlüssel.
- Aktiviere die Analytics API in der Google API Console. Überspringe diesen Schritt, falls die API nicht in der API Console aufgeführt ist.
- Wenn deine Anwendung Zugriff auf Nutzerdaten benötigt, bittet sie Google um einen bestimmten Zugriffsbereich.
- Dem Nutzer wird von Google ein Zustimmungsbildschirm angezeigt, auf dem er gebeten wird, deine Anwendung dazu zu autorisieren, einige seiner Daten abzufragen.
- Wenn der Nutzer zustimmt, erhält deine Anwendung von Google ein kurzlebiges Zugriffstoken.
- Die Anwendung fordert Nutzerdaten an, wobei das Zugriffstoken an die Anfrage angehängt wird.
- Stellt Google fest, dass Ihre Anfrage und das Token gültig sind, werden die angeforderten Daten zurückgegeben.
Einige Abläufe enthalten zusätzliche Schritte, beispielsweise die Verwendung von Aktualisierungstoken zum Erhalt neuer Zugriffstoken. Weitere Informationen über die Abläufe für die unterschiedlichen Anwendungstypen findest du in der OAuth 2.0-Dokumentation.
Im Folgenden finden Sie die Informationen zum Umfang von OAuth 2.0 für die Analytics API:
Umfang | Bedeutung |
---|---|
https://www.googleapis.com/auth/analytics.user.deletion |
Daten mit der User Deletion API löschen |
Zur Anforderung eines Zugriffs mit OAuth 2.0 benötigt Ihre Anwendung die Informationen zum Umfang sowie die Informationen, die Google bei der Registrierung Ihrer Anwendung bereitstellt, z. B. die Client-ID und den Clientschlüssel.
Tipp: Die Google APIs-Clientbibliotheken können einige Schritte des Autorisierungsvorgangs für Sie übernehmen. Sie sind für verschiedene Programmiersprachen verfügbar. Weitere Informationen erhältst du auf der Seite Bibliotheken und Beispiele.
Gängige OAuth 2.0-Vorgänge
Im Folgenden sind häufige Anwendungsfälle für bestimmte OAuth 2.0-Abläufe aufgeführt:
Webserver
Dieser Ablauf eignet sich für den automatisierten, Offline- oder geplanten Zugriff auf die Google Analytics-Daten eines Nutzers.
Beispiel:
- Nutzer-Dashboards werden automatisch mit den neuesten Google Analytics-Daten aktualisiert.
Clientseitig
Dieser Ablauf eignet sich ideal für Anwendungen, bei denen Nutzer direkt mit der Anwendung interagieren, um in einem Browser auf ihre Google Analytics-Daten zuzugreifen. Dadurch sind keine serverseitigen Funktionen mehr erforderlich, aber automatisierte, Offline- oder geplante Berichte sind nicht mehr praktikabel.
Beispiel:
- Ein browserbasiertes Berichtstool wie der Analytics Query Explorer
Installierte Apps
Dieser Ablauf gilt für Anwendungen, die als Paket bereitgestellt und vom Nutzer installiert werden. Für diesen Ablauf muss die Anwendung oder der Nutzer Zugriff auf einen Browser haben, um den Authentifizierungsvorgang abzuschließen.
Beispiele:
- Ein Desktop-Widget auf einem PC oder Mac
- Ein Plug-in für ein Content-Management-System: Der Vorteil dieses Ablaufs im Vergleich zur Webserver- oder Clientseite besteht darin, dass für Ihre Anwendung ein einzelnes API Console-Projekt verwendet werden kann. So können Berichte konsolidiert und die Installation für Nutzer vereinfacht werden.
Dienstkonten
Dienstkonten eignen sich für den automatisierten, Offline- oder geplanten Zugriff auf Google Analytics-Daten in Ihrem eigenen Konto. So können Sie beispielsweise ein Live-Dashboard mit Ihren eigenen Google Analytics-Daten erstellen und für andere Nutzer freigeben.
Damit du die Analytics API verwenden kannst, musst du zuerst mithilfe des Einrichtungstools ein Projekt in der Google API Console erstellen. Dadurch wird die API aktiviert und Anmeldedaten erzeugt.
So richten Sie ein neues Dienstkonto ein:
- Klicken Sie auf Anmeldedaten erstellen > Dienstkontoschlüssel.
- Wählen Sie aus, ob Sie den öffentlichen/privaten Schlüssel des Dienstkontos als Standard-P12-Datei oder als JSON-Datei herunterladen möchten, die von einer Google API-Clientbibliothek geladen werden kann.
Ihr neues öffentliches/privates Schlüsselpaar wird generiert und auf Ihren Computer heruntergeladen. Dies ist die einzige Kopie dieses Schlüssels. Sie sind dafür verantwortlich, ihn sicher aufzubewahren.
Fehlerbehebung
In folgenden Fällen schlägt die Autorisierung fehl:
Sie erhalten einen
401
-Statuscode, wenn Ihraccess_token
abgelaufen ist oder Sie den falschen Umfang für die API verwenden.Sie erhalten den Statuscode
403
, wenn der autorisierte Nutzer keinen Zugriff auf die Datenansicht (Profil) hat. Prüfen Sie, ob Sie mit dem richtigen Nutzer autorisiert sind und ob dieser Nutzer die von Ihnen ausgewählte Ansicht (Profil) hat.
OAuth 2.0 Playground
Mit diesem Tool können Sie den gesamten Autorisierungsablauf über eine Weboberfläche durchlaufen. Außerdem werden alle HTTP-Anfrageheader angezeigt, die für eine autorisierte Abfrage erforderlich sind. Wenn Sie die Autorisierung für Ihre eigene Anwendung nicht erhalten können, sollten Sie versuchen, sie über den OAuth 2.0 Playground zum Laufen zu bringen. Anschließend können Sie die HTTP-Header und die Anfrage aus dem Playground mit den Daten vergleichen, die Ihre Anwendung an Google Analytics sendet. So können Sie ganz einfach prüfen, ob Ihre Anfragen richtig formatiert sind.
Ungültige Berechtigung
Wenn Sie versuchen, ein Aktualisierungstoken zu verwenden, wird der folgende invalid_grant
-Fehler zurückgegeben:
- Die Uhr Ihres Servers ist nicht mit dem Network Time Protocol (NTP) synchronisiert.
- Das Limit für Aktualisierungstokens wurde überschritten.
Anwendungen können mehrere Aktualisierungstokens anfordern, um auf ein einzelnes Google Analytics-Konto zuzugreifen.
Wenn ein Nutzer beispielsweise eine Anwendung auf mehreren Computern installieren und auf dasselbe Google Analytics-Konto zugreifen möchte, ist für jeden Computer ein separates Token erforderlich. Wenn die Anzahl der Aktualisierungstokens das Limit überschreitet, werden ältere Tokens ungültig. Wenn die Anwendung versucht, ein ungültiges Aktualisierungstoken zu verwenden, wird eine invalid_grant
-Fehlerantwort zurückgegeben.
Für jedes eindeutige Paar aus OAuth 2.0-Client und Google Analytics-Konto gilt ein Limit von 25 Aktualisierungstokens. Wenn die Anwendung weiterhin Aktualisierungstokens für dasselbe Client-/Kontopaar anfordert, wird das erste zuvor ausgestellte Aktualisierungstoken ungültig, sobald das 26. Token ausgestellt wurde. Das 27. angeforderte Aktualisierungstoken würde das zweite zuvor ausgestellte Token ungültig machen und so weiter.