Method: properties.runRealtimeReport

Hier sehen Sie einen benutzerdefinierten Bericht mit Echtzeit-Ereignisdaten für Ihre Property. Ereignisse werden in Echtzeitberichten Sekunden nach dem Senden an Google Analytics angezeigt. Echtzeitberichte enthalten Ereignisse und Nutzungsdaten für den Zeitraum von aktuell bis vor 30 Minuten (bis zu 60 Minuten für Google Analytics 360-Properties).

Eine Anleitung zum Erstellen von Echtzeitanfragen und zum Auswerten 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

Die ID einer Google Analytics-Property, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen finden Sie unter Property-ID ermitteln.

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. In diesem Filter können keine Messwerte verwendet werden.
metricFilter

object (FilterExpression)

Die Filterklausel für Messwerte. Wird nach der Aggregationsphase angewendet, ähnlich wie die SQL-Having-Klausel. Dimensionen können in diesem Filter nicht verwendet werden.
limit

string (int64 format)

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

Die API kann auch weniger Zeilen als die angeforderte limit zurückgeben, wenn es nicht so viele Dimensionswerte wie die limit gibt. Wenn für die Dimension country beispielsweise weniger als 300 mögliche Werte vorhanden sind, können Sie in Berichten, die nur auf country basieren, nicht mehr als 300 Zeilen erhalten, auch wenn Sie limit auf einen höheren Wert festlegen.
metricAggregations[]

enum (MetricAggregation)

Aggregation von Messwerten. Aggregierte Messwertwerte werden in Zeilen angezeigt, in denen die Dimensionswerte auf „RESERVED_(MetricAggregation)“ festgelegt sind.
orderBys[]

object (OrderBy)

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

boolean

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

object (MinuteRange)

Die Minutenbereiche der Ereignisdaten, die gelesen werden sollen. Wenn keine Angabe gemacht wird, wird ein Minutenbereich für die letzten 30 Minuten verwendet. Wenn mehrere Minutenbereiche angefordert werden, enthält jede Antwortzeile einen Index für den Minutenbereich, der auf null basiert. Wenn sich zwei Minutenbereiche überschneiden, sind die Ereignisdaten für die überlappenden Minuten in den Antwortzeilen für beide Minutenbereiche enthalten.

Antworttext

Die Tabelle mit den Echtzeitberichten zu einer Anfrage.

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 DimensionsHeaders und die Reihenfolge der DimensionsHeaders stimmen mit den in den Zeilen vorhandenen Dimensionen überein.
metricHeaders[]

object (MetricHeader)

Beschreibt Messwertspalten. Die Anzahl der Messwertüberschriften und ihre Reihenfolge stimmen mit den Messwerten in den Zeilen überein.
rows[]

object (Row)

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

object (Row)

Auf Anfrage die Summe der Messwerte.
maximums[]

object (Row)

Auf Anfrage: die Maximalwerte der Messwerte.
minimums[]

object (Row)

Sofern angefordert, die Mindestwerte der Messwerte.
rowCount

integer

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

object (PropertyQuota)

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

string

Gibt an, um welche Art von Ressource es sich bei dieser Nachricht handelt. Diese kind ist immer der feste String „analyticsData#runRealtimeReport“. 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

MinuteRange

Eine zusammenhängende Reihe von Minuten: startMinutesAgo, startMinutesAgo + 1, …, endMinutesAgo. Anfragen sind bis zu einem Zeitraum von 2 Minuten zulässig.

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

string

Diesem Minutenbereich wird ein Name zugewiesen. Der Wert der Dimension dateRange wird in einer Berichtsantwort mit diesem Namen angegeben. Wenn festgelegt, darf der Wert nicht mit date_range_ oder RESERVED_ beginnen. Wenn nicht festgelegt, werden Minutenbereiche in der Anfrage anhand ihres Index (ab null) benannt: date_range_0, date_range_1 usw.
startMinutesAgo

integer

Die Minute, ab der die Abfrage beginnt, als Anzahl der Minuten vor dem aktuellen Zeitpunkt. Mit "startMinutesAgo": 29 wird beispielsweise angegeben, dass der Bericht Ereignisdaten von vor 29 Minuten und danach enthalten soll. Das Datum darf nicht nach dem endMinutesAgo liegen.

Wenn nicht angegeben, wird für startMinutesAgo standardmäßig 29 verwendet. Für Standard-Analytics-Properties können Ereignisdaten bis zu den letzten 30 Minuten (startMinutesAgo <= 29) angefordert werden. Für 360-Analytics-Properties können Ereignisdaten bis zu den letzten 60 Minuten (startMinutesAgo <= 59) angefordert werden.
endMinutesAgo

integer

Die Endminute der Abfrage als Anzahl der Minuten vor dem aktuellen Zeitpunkt. Das Datum darf nicht vor dem startMinutesAgo liegen. Mit "endMinutesAgo": 15 wird beispielsweise angegeben, dass der Bericht Ereignisdaten von vor 15 Minuten enthalten soll.

Wenn nicht angegeben, ist der Standardwert für endMinutesAgo 0. Für Standard-Analytics-Properties können Ereignisdaten (endMinutesAgo <= 29) aus jeder Minute der letzten 30 Minuten angefordert werden. Für 360-Analytics-Properties können Ereignisdaten (endMinutesAgo <= 59) aus jeder Minute der letzten 60 Minuten angefordert werden.