Method: properties.runRealtimeReport

Gibt einen benutzerdefinierten Bericht mit Echtzeitereignisdaten für Ihre Property zurück. Ereignisse werden innerhalb von Sekunden nach dem Senden an Google Analytics in Echtzeitberichten angezeigt. Echtzeitberichte enthalten Ereignisse und Nutzungsdaten für einen Zeitraum, der vom aktuellen Zeitpunkt bis zu 30 Minuten zurückliegt (bis zu 60 Minuten bei Google Analytics 360-Properties).

Eine Anleitung zum Erstellen von Echtzeitanfragen und zum Verständnis von Antworten finden Sie unter Echtzeitberichte erstellen.

HTTP-Anfrage

POST https://analyticsdata.googleapis.com/v1beta/{property=properties/*}:runRealtimeReport

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
property

string

Eine Google Analytics GA4-Property-ID, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen dazu, wo Sie die Property-ID finden

Beispiel: properties/1234

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean,
  "minuteRanges": [
    {
      object (MinuteRange)
    }
  ]
}
Felder
dimensions[]

object (Dimension)

Die angeforderten und angezeigten Dimensionen.
metrics[]

object (Metric)

Die angeforderten und angezeigten Messwerte.
dimensionFilter

object (FilterExpression)

Die Filterklausel der Dimensionen. Messwerte können in diesem Filter nicht verwendet werden.
metricFilter

object (FilterExpression)

Die Filterklausel von Messwerten. Wird in der Post-Aggregationsphase angewendet, ähnlich wie bei SQL-Klauseln. Dimensionen können in diesem Filter nicht verwendet werden.
limit

string (int64 format)

Die Anzahl der zurückzugebenden Zeilen. Wenn kein Wert angegeben ist, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 250.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Zeilen Sie anfordern. limit muss positiv sein.

Die API kann auch weniger Zeilen als die angeforderte Anzahl von limit zurückgeben, wenn nicht so viele Dimensionswerte wie limit vorhanden sind. Beispielsweise gibt es weniger als 300 mögliche Werte für die Dimension „country“. Wenn Sie einen Bericht nur für country erstellen, können Sie also nicht mehr als 300 Zeilen erhalten, selbst wenn Sie für limit einen höheren Wert festlegen.
metricAggregations[]

enum (MetricAggregation)

Zusammenfassung von Messwerten. Zusammengefasste Messwerte werden in Zeilen angezeigt, in denen „dimensionValues“ auf „RESERVED_(MetricAggregation)“ festgelegt ist.
orderBys[]

object (OrderBy)

Gibt an, wie Zeilen in der Antwort sortiert werden.
returnPropertyQuota

boolean

Gibt an, ob der aktuelle Status des Echtzeitkontingents dieser Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyQuota zurückgegeben.
minuteRanges[]

object (MinuteRange)

Die Minutenbereiche der zu lesenden Ereignisdaten. Wenn kein Wert angegeben ist, wird ein Minutenbereich der letzten 30 Minuten verwendet. Wenn mehrere Minutenbereiche angefordert werden, enthält jede Antwortzeile einen nullbasierten Minutenbereichsindex. Wenn sich zwei Minutenbereiche überschneiden, werden die Ereignisdaten für die sich überschneidenden Minuten in den Antwortzeilen für beide Minutenbereiche enthalten.

Antworttext

Die Tabelle im Echtzeitbericht der Antwort, die einer Anfrage entspricht

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string
}
Felder
dimensionHeaders[]

object (DimensionHeader)

Beschreibt Dimensionsspalten. Die Anzahl der DimensionHeaders und die Reihenfolge der DimensionHeaders stimmen mit den Dimensionen in den Zeilen überein.
metricHeaders[]

object (MetricHeader)

Beschreibt Messwertspalten. Die Anzahl der MetricHeader und die Reihenfolge der MetricHeaders entsprechen den Messwerten in den Zeilen.
rows[]

object (Row)

Zeilen mit Kombinationen aus Dimensionswerten und Messwerten im Bericht.
totals[]

object (Row)

Auf Anfrage die Gesamtwerte der Messwerte.
maximums[]

object (Row)

Auf Anfrage die Maximalwerte von Messwerten.
minimums[]

object (Row)

Auf Anfrage die Mindestwerte von Messwerten.
rowCount

integer

Die Gesamtzahl der Zeilen im Abfrageergebnis. rowCount ist unabhängig von der Anzahl der in der Antwort zurückgegebenen Zeilen und dem Anfrageparameter limit. Wenn eine Abfrage beispielsweise 175 Zeilen zurückgibt und die API-Anfrage limit von 50 enthält, enthält die Antwort rowCount von 175, aber nur 50 Zeilen.
propertyQuota

object (PropertyQuota)

Status des Echtzeitkontingents dieser Analytics-Property, einschließlich dieser Anfrage.
kind

string

Gibt an, um welche Art von Ressource diese Nachricht geht. Diese kind ist immer der feste String „analyticsData#runRealtimeReport“. Dies ist hilfreich, um zwischen Antworttypen in JSON zu unterscheiden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

  • https://www.googleapis.com/auth/analytics.readonly
  • https://www.googleapis.com/auth/analytics

MinutenBereich

Ein aufeinanderfolgender Satz von Minuten: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Anfragen sind für Zeiträume von bis zu 2 Minuten zulässig.

JSON-Darstellung 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
Felder
name

string

Weist diesem Minutenbereich einen Namen zu. Die Dimension „dateRange“ wird in einer Berichtsantwort als dieser Name bewertet. Wenn festgelegt, darf sie nicht mit date_range_ oder RESERVED_ beginnen. Wenn nicht festgelegt, werden Minutenbereiche nach ihrem nullbasierten Index in der Anfrage benannt: date_range_0, date_range_1 usw.
startMinutesAgo

integer

Die inklusive Startminute für die Abfrage in Minuten vor dem aktuellen Zeitpunkt. Beispielsweise gibt "startMinutesAgo": 29 an, dass der Bericht Ereignisdaten von vor und nach 29 Minuten enthalten soll. Darf nicht nach endMinutesAgo liegen.

Wenn keine Vorgabe erfolgt, wird für startMinutesAgo der Standardwert 29 verwendet. Bei standardmäßigen Analytics-Properties können Ereignisdaten der letzten 30 Minuten angefordert werden (startMinutesAgo <= 29). Bei 360-Properties können Ereignisdaten der letzten 60 Minuten (startMinutesAgo <= 59) angefordert werden.
endMinutesAgo

integer

Die inklusive Endminute für die Abfrage in Minuten vor dem aktuellen Zeitpunkt. Darf nicht vor startMinutesAgo liegen. Beispielsweise gibt "endMinutesAgo": 15 an, dass der Bericht Ereignisdaten von vor 15 Minuten enthalten soll.

Wenn keine Vorgabe erfolgt, wird für endMinutesAgo der Standardwert 0 verwendet. Für Analytics-Standard-Properties können Ereignisdaten für jede Minute innerhalb der letzten 30 Minuten (endMinutesAgo <= 29) und für 360-Properties in den letzten 60 Minuten Ereignisdaten (endMinutesAgo <= 59) angefordert werden.