Entwicklerleitfaden

In diesem Dokument wird beschrieben, wie Sie mit der Real Time Reporting API Google Analytics-Daten abrufen.

Einführung

Mit der Real Time Reporting API können Sie Aktivitäten melden, die derzeit in Ihrer Property stattfinden. Für den Zugriff auf die Echtzeitdaten erstellen Sie eine Abfrage, die eine Datenansicht (Profil) und mindestens einen Messwert angibt. Sie können auch zusätzliche Abfrageparameter wie Dimensionen und Filter angeben, um die Abfrage zu verfeinern. Diese Abfrage wird an die Real Time Reporting API gesendet, die die Daten in Form einer Tabelle zurückgibt.

Wenn Sie die API noch nicht kennen, finden Sie unter Übersicht über die Real Time Reporting API eine Einführung in die Real Time Reporting API und die darin enthaltenen Daten.

Vorbereitung

Bevor Sie die Real Time Reporting API zum Abrufen von Google Analytics-Daten verwenden:

  • Auf der Seite Clientbibliotheken finden Sie eine vollständige Liste der programmiersprachenspezifischen Clientbibliotheken, die mit der API funktionieren.
  • In diesem Referenzhandbuch erfahren Sie, wie Sie allein mit der API (ohne Clientbibliothek) Google Analytics-Daten abrufen.

Jede Clientbibliothek stellt ein einzelnes Analysedienstobjekt für den Zugriff auf alle Daten der Real Time Reporting API bereit. So erstellen Sie ein Dienstobjekt:

  1. Registrieren Sie Ihre Anwendung in der Google API Console.
  2. Autorisieren Sie den Zugriff auf Google Analytics-Daten.
  3. Erstellen Sie ein Analytics-Dienstobjekt.

Falls Sie diese Schritte noch nicht ausgeführt haben, beenden Sie bitte die Anleitung zur Hello Google Analytics API, die Sie durch die ersten Schritte zum Erstellen einer Google Analytics API-Anwendung führt. Danach wissen Sie, wie Sie mit der API Google Analytics-Daten abrufen.

Real Time Reporting API verwenden

So verwenden Sie die Real Time Reporting API:

  1. Fragt die Real Time Reporting API ab.
  2. Verarbeitet die API-Antwort.

Real Time Reporting API abfragen

Das Analysedienstobjekt bietet eine Methode zum Erstellen einer Real Time Reporting API-Abfrage. Weitere Informationen zu den Abfrageparametern und Daten, die für die API verfügbar sind, finden Sie unter:

Nachdem Sie eine Abfrage definiert haben, rufen Sie deren execute-Methode auf, um die Abfrage an die Google Analytics-Server zu senden.

API-Antwort verarbeiten

Wenn eine Abfrage an die Real Time Reporting API erfolgreich ist, gibt die API die angeforderten Daten als Teil einer Echtzeit-Datenressource zurück. Weitere Informationen zu Struktur und Format der API-Antwort finden Sie in der Referenz zur Real Time Reporting API.

Wenn Fehler auftreten, gibt die API einen bestimmten Statuscode und eine Meldung mit einer Beschreibung des Fehlers zurück. Alle Anwendungen sollten Fehler erfassen und verarbeiten. Eine detaillierte Liste der Fehler und Empfehlungen für Wiederholungsversuche finden Sie unter Fehlerantworten .

Codebeispiele

Der Abschnitt Beispiele auf der Seite Echtzeitdaten: get enthält Beispielcode in verschiedenen Programmiersprachen, um die Real Time Reporting API abzufragen und die API-Antwort zu verarbeiten.

Abfrageeinschränkungen

Für Real Time API-Abfragen gelten die folgenden Einschränkungen:

  • Wenn der Messwert rt:activeUsers in einer Abfrage mit den folgenden Dimensionsfiltern enthalten ist, werden nur der Operator AND und die Keyword-Option „Gleichheit“ (==) unterstützt.
    • rt:goalId
    • rt:eventAction
    • rt:eventCategory
    • rt:eventLabel

    Da mit dem Messwert rt:activeUsers nur die Anzahl der derzeit auf der Website aktiven Nutzer abgerufen werden, verwende rt:minutesAgo nicht mit rt:activeUsers. Das heißt, rt:activeUsers impliziert, dass rt:minutesAgo 0 ist.

  • Messwertfilter werden nicht unterstützt.
  • Der Parameter fields wird nicht unterstützt.

Kontingentverwaltung

Wie im Abschnitt Limits und Kontingente beschrieben, gelten für die Real Time Reporting API Tageskontingente, die auch für andere Google Analytics APIs gelten. Wenn Sie die Real Time Reporting API in kurzen Intervallen abfragen, erreichen Sie die täglichen Kontingentlimits sehr schnell. In diesem Fall funktionieren auch Anfragen von anderen Google Analytics APIs erst wieder, wenn das Kontingent erneuert wurde.

Hier einige Beispiele für Implementierungen, die das Kontingent sehr schnell aufbrauchen können:

  • Sie haben mehrere Echtzeit-Dashboards, die Daten für eine einzelne Google Analytics-Datenansicht (Profil) in sehr kurzen Intervallen täglich abfragen.
  • Sie haben eine Property mit vielen Nutzern und haben ein Echtzeit-Widget implementiert. Jedes Mal, wenn einem Nutzer das Widget angezeigt wird, fragen Sie direkt Google Analytics ab, anstatt einen Cache zu verwenden.

So minimieren Sie die Kontingentnutzung und verwalten sie effizient:

  • Implementieren Sie das serverseitige Caching. Wenn mehrere Nutzer dieselben Echtzeitdaten anfragen, sollten Sie eine im Cache gespeicherte Antwort zurückgeben, anstatt die Real Time Reporting API für jede Nutzeranfrage direkt abzufragen. Aktualisieren Sie den Cache dann regelmäßig mit den neuesten Echtzeitdaten in einem angemessenen Aktualisierungsintervall, um eine Überschreitung der täglichen Kontingentlimits zu vermeiden.
  • Sie können mehrere Abfragen kombinieren, indem Sie zusätzliche Dimensionen angeben und die Antwort server- oder clientseitig analysieren.
  • Erhöhen Sie das Zeitintervall, in dem Sie Echtzeitdaten anfordern.

Beispiel: Aktualisierungsintervall berechnen

Wenn Sie davon ausgehen, regelmäßige Anfragen für Echtzeitdaten zu senden, sollten Sie ein angemessenes Aktualisierungsintervall basierend auf Ihrer erwarteten Nutzung auswählen.

Beispielsweise hat eine einzelne Google Analytics-Datenansicht (Profil) ein Tageslimit von 10.000 Anfragen pro Tag. Wenn Sie an einem Tag damit rechnen, für eine einzelne Datenansicht (Profil) 6.000 Abfragen an die Core Reporting API zu senden, stehen Ihnen für diese Datenansicht (Profil) noch 4.000 Anfragen zur Verfügung.

Angenommen, Sie möchten die Real Time Reporting API verwenden, um drei Echtzeit-Dashboards zu implementieren, in denen ganztägig Echtzeitdaten aus derselben Datenansicht (einem Profil) abgefragt werden. Jedes Dashboard kann etwa 1.333 Abfragen pro Tag ausführen (4.000 Abfragen ÷ 3 Dashboards). Ein Tag hat 86.400 Sekunden. Daher muss das Aktualisierungsintervall für jedes Dashboard länger als 65 Sekunden (86.400 ÷ 1.333) sein, damit die Gesamtzahl der täglichen Anfragen für die Ansicht (Profil) unter dem Tageslimit von 4.000 liegt.