Method: properties.runRealtimeReport

Sie erhalten einen benutzerdefinierten Bericht mit Echtzeit-Ereignisdaten für Ihre Property. Ereignisse werden Sekunden, nachdem sie an Google Analytics gesendet wurden, in Echtzeitberichten angezeigt. In Echtzeitberichten werden Ereignisse und Nutzungsdaten für einen bestimmten Zeitraum angezeigt, der vom aktuellen Zeitpunkt bis zur letzten 30 Minuten dauert (bei Google Analytics 360-Properties bis zu 60 Minuten).

Eine Anleitung zum Erstellen von Echtzeitanfragen und zum Verständnis der 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

string

Eine GA4-Property-ID in Google Analytics, deren Ereignisse erfasst werden. 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 (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 Abmessungen.

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. In diesem Filter können keine Dimensionen 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 angefordert werden. limit muss positiv sein.

Die API kann auch weniger Zeilen als die angefragte limit zurückgeben, wenn nicht so viele Dimensionswerte wie limit vorhanden sind. Für die Dimension "country" sind beispielsweise weniger als 300 Werte möglich. Wenn Sie also nur einen Bericht für "country" erstellen, können Sie 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_(MesswertAggregation)“ festgelegt ist.

orderBys[]

object (OrderBy)

Gibt an, wie Zeilen in der Antwort angeordnet 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 mit dem 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 MetricHeaders 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 Abfrageergebniss. rowCount ist unabhängig von der Anzahl der in der Antwort zurückgegebenen Zeilen und dem limit-Anfrageparameter. Wenn eine Abfrage beispielsweise 175 Zeilen zurückgibt und die API-Anfrage für limit den Wert 50 enthält, enthält die Antwort den Wert rowCount von 175, aber nur 50 Zeilen.

propertyQuota

object (PropertyQuota)

Der Echtzeit-Kontingentstatus dieser Analytics-Property, einschließlich dieser Anfrage.

kind

string

Gibt an, welche Art von Ressource diese Nachricht ist. Diese kind ist immer der feste String „analyticsData#runRealtimeReport“. Nützlich, 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

MinuteRange

Ein zusammenhängender Satz von Minuten: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Anfragen sind in einem Zeitraum 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 diesem Namen zugeordnet. 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 einschließliche 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 dem endMinutesAgo liegen.

Wenn keine Angabe erfolgt, ist startMinutesAgo standardmäßig auf 29 gesetzt. In Analytics-Standard-Properties können Ereignisdaten der letzten 30 Minuten angefordert werden (startMinutesAgo <= 29). Bei Analytics-360-Properties können hingegen Ereignisdaten der letzten 60 Minuten angefordert werden (startMinutesAgo <= 59).

endMinutesAgo

integer

Die einschließende Minute für die Abfrage in Minuten vor dem aktuellen Zeitpunkt. Darf nicht vor dem startMinutesAgo liegen. Beispielsweise gibt "endMinutesAgo": 15 an, dass der Bericht Ereignisdaten enthalten soll, die älter als 15 Minuten sind.

Wenn keine Angabe erfolgt, wird endMinutesAgo standardmäßig auf 0 gesetzt. Analytics-Standard-Properties können jede Minute der Ereignisdaten in den letzten 30 Minuten anfordern (endMinutesAgo <= 29). Analytics-360-Properties können jede Minute der Ereignisdaten der letzten 60 Minuten anfordern (endMinutesAgo <= 59).