Gibt einen benutzerdefinierten Bericht mit Echtzeit-Ereignisdaten für Ihre Property zurück. Ereignisse werden Sekunden, nachdem sie an Google Analytics gesendet wurden, in Echtzeitberichten angezeigt. Echtzeitberichte enthalten Ereignisse und Nutzungsdaten für einen Zeitraum zwischen dem aktuellen Moment und 30 Minuten (für Google Analytics 360-Properties bis zu 60 Minuten).
Eine Anleitung zum Erstellen von Echtzeitanfragen und Antworten finden Sie unter Echtzeitbericht erstellen.
HTTP-Anfrage
POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport
Die URL verwendet die Syntax der gRPC-Transcodierung.
Pfadparameter
Parameter | |
---|---|
property |
Eine GA4-Property-ID, deren Ereignisse erfasst werden. Sie wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen zum Ermitteln der Property-ID Beispiel: properties/1234 |
Anfragetext
Der Anfragetext enthält Daten mit folgender Struktur:
JSON-Darstellung |
---|
{ "dimensions": [ { object ( |
Felder | |
---|---|
dimensions[] |
Die angeforderten Dimensionen werden angezeigt. |
metrics[] |
Die angeforderten und angezeigten Messwerte. |
dimensionFilter |
Die Filterklausel mit den Dimensionen. In diesem Filter können keine Messwerte verwendet werden. |
metricFilter |
Die Filterklausel mit Messwerten. Wird nach der Zusammenfassung angewendet, ähnlich wie bei der SQL-Klausel. In diesem Filter können keine Dimensionen verwendet werden. |
limit |
Die Anzahl der zurückzugebenden Zeilen. Wenn keine Angabe erfolgt, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 100.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Sie anfordern. Die API kann auch weniger Zeilen als die angeforderte |
metricAggregations[] |
Zusammenfassung von Messwerten. Zusammengefasste Messwerte werden in Zeilen angezeigt, in denen „dimensionValues“ auf „RESERVED_(Messwertaggregation)“ gesetzt ist. |
orderBys[] |
Gibt an, wie Zeilen in der Antwort angeordnet sind. |
returnPropertyQuota |
Gibt an, ob der aktuelle Status des Echtzeitkontingents für diese Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyKontingent zurückgegeben. |
minuteRanges[] |
Die Minutenbereiche der zu lesenden Ereignisdaten. Wenn keine Angabe erfolgt, wird ein Minutenbereich der letzten 30 Minuten verwendet. Wenn mehrere Minutenbereiche angefordert werden, enthält jede Antwortzeile einen nullbasierten Minutenbereichindex. Wenn sich zwei Minuten überschneiden, werden die Ereignisdaten für die sich überschneidenden Minuten in den Antwortzeilen für beide Minutenbereiche angezeigt. |
Antworttext
Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:
Tabelle mit Echtzeitdaten zur Antwort, die einer Anfrage entspricht.
JSON-Darstellung |
---|
{ "dimensionHeaders": [ { object ( |
Felder | |
---|---|
dimensionHeaders[] |
Beschreibt Dimensionsspalten. Die Anzahl der DimensionHeader und die Reihenfolge der DimensionHeaders entsprechen den Abmessungen in Zeilen. |
metricHeaders[] |
Beschreibt Messwertspalten. Die Anzahl der MetrikHeader und die Reihenfolge der MetrikHeader entsprechen den Metriken, die in den Zeilen vorhanden sind. |
rows[] |
Zeilen mit Dimensionswertkombinationen und Messwerten im Bericht |
totals[] |
Auf Anfrage die Gesamtwerte der Messwerte. |
maximums[] |
Auf Anfrage die Maximalwerte der Messwerte. |
minimums[] |
Auf Anfrage die Mindestwerte von Messwerten. |
rowCount |
Die Gesamtzahl der Zeilen im Abfrageergebnis. |
propertyQuota |
Der Kontingentstatus der Analytics-Property, einschließlich dieser Anfrage. |
kind |
Gibt die Art der Ressource an. Diese |
Autorisierungsbereiche
Erfordert einen der folgenden OAuth-Bereiche:
https://www.googleapis.com/auth/analytics.readonly
https://www.googleapis.com/auth/analytics
Minutenbereich
Mehrere aufeinanderfolgende Minuten: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Anfragen sind bis zu zwei Minuten zulässig.
JSON-Darstellung |
---|
{ "name": string, "startMinutesAgo": integer, "endMinutesAgo": integer } |
Felder | |
---|---|
name |
Weist diesem Minutenbereich einen Namen zu. Die Dimension „ |
startMinutesAgo |
Die inklusive Startzeit für die Abfrage als Anzahl der Minuten vor dem aktuellen Zeitpunkt. Beispiel: Wenn kein Wert angegeben ist, wird standardmäßig |
endMinutesAgo |
Die inklusive Endzeit für die Abfrage als Anzahl der Minuten vor dem aktuellen Zeitpunkt. Darf nicht vor dem Wenn kein Wert angegeben ist, wird standardmäßig |