Method: properties.runRealtimeReport

Gibt einen benutzerdefinierten Bericht mit Echtzeitereignisdaten 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 den ausgewählten Zeitraum – vom aktuellen Moment bis zu den letzten 30 Minuten (bei Google Analytics 360-Properties bis zu 60 Minuten).

Anleitung zum Erstellen von Echtzeitanfragen und Informationen zu 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 Google Analytics GA4-Property-ID, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen dazu, wo Sie Ihre 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 von Dimensionen. In diesem Filter können keine Messwerte verwendet werden.
metricFilter

object (FilterExpression)

Die Filterklausel von Messwerten. Wird in der Post-Aggregationsphase angewendet, ähnlich der SQL-With-Klausel. In diesem Filter können keine Dimensionen verwendet werden.
limit

string (int64 format)

Die Anzahl der zurückzugebenden Zeilen. Wenn nicht angegeben, 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 angeforderte limit zurückgeben, wenn nicht so viele Dimensionswerte wie der limit vorhanden sind. Für die Dimension country sind beispielsweise weniger als 300 Werte möglich. Wenn Sie also nur Daten für country erstellen, können Sie nicht mehr als 300 Zeilen abrufen, selbst wenn Sie für limit einen höheren Wert festlegen.
metricAggregations[]

enum (MetricAggregation)

Aggregation von Messwerten. Aggregierte Messwerte werden in Zeilen angezeigt, in denen die DimensionValues auf „RESERVED_(MetricAggregation)“ festgelegt ist.
orderBys[]

object (OrderBy)

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

boolean

Mit dieser Option kann festgelegt werden, ob der aktuelle Status des Realtime-Kontingents für diese Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyQuota zurückgegeben.
minuteRanges[]

object (MinuteRange)

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

Antworttext

Die Echtzeitberichtstabelle für Antworten, 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 von DimensionHeaders entsprechen den Dimensionen in den Zeilen.
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 Dimensionswertkombinationen und Messwerten im Bericht.
totals[]

object (Row)

Auf Anfrage die Gesamtwerte der Messwerte.
maximums[]

object (Row)

Auf Anfrage die Maximalwerte der Messwerte.
minimums[]

object (Row)

Bei Bedarf die Mindestwerte für Messwerte.
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 limit von 50 in die API-Anfrage einschließt, enthält die Antwort rowCount von 175 Zeilen, aber nur 50 Zeilen.
propertyQuota

object (PropertyQuota)

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

string

Gibt an, um welche Art von Ressource diese Nachricht handelt. Dieser 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 können bis zu 2 Minuten betragen.

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

string

Weist diesem Minutenbereich einen Namen zu. Die Dimension „dateRange“ wird in einer Berichtsantwort auf diesen Namen geschätzt. Wenn festgelegt, darf nicht mit date_range_ oder RESERVED_ beginnen. Wenn nichts festgelegt ist, werden Minutenbereiche in der Anfrage nach ihrem nullbasierten Index benannt: date_range_0, date_range_1 usw.
startMinutesAgo

integer

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

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

integer

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

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