Method: properties.runRealtimeReport

Gibt einen benutzerdefinierten Bericht mit Echtzeit-Ereignisdaten für Ihre Property zurück. Ereignisse werden in Echtzeitberichten angezeigt, sobald sie an Google Analytics gesendet wurden. In Echtzeitberichten werden Ereignis- und Nutzungsdaten für die Zeiträume vom aktuellen Zeitpunkt bis vor 30 Minuten angezeigt (bis zu 60 Minuten für Google Analytics 360-Properties).

Eine Anleitung zum Erstellen von Echtzeitanfragen und zum Interpretieren von 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-Property-ID, deren Ereignisse erfasst werden. Wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen finden Sie unter 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 für Dimensionen. Messwerte können in diesem Filter nicht verwendet werden.
metricFilter

object (FilterExpression)

Die Filterklausel für Messwerte. Wird in der Phase nach der Aggregation angewendet, ähnlich der HAVING-Klausel in SQL. Dimensionen können in diesem Filter nicht 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 Sie anfordern. limit muss positiv sein.

Die API kann auch weniger Zeilen als das angeforderte limit zurückgeben, wenn es nicht so viele Dimensionswerte wie das limit gibt. Für die Dimension country gibt es beispielsweise weniger als 300 mögliche Werte. Wenn Sie also nur Berichte zu country erstellen, können Sie nicht mehr als 300 Zeilen erhalten, auch wenn Sie limit auf 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 sind.
orderBys[]

object (OrderBy)

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

boolean

Legt fest, 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 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 Index für den Minutenbereich. Wenn sich zwei Minutenbereiche überschneiden, werden die Ereignisdaten für die sich überschneidenden Minuten in den Antwortzeilen für beide Minutenbereiche berücksichtigt.

Antworttext

Die Echtzeitberichtstabelle in 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 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 Kombinationen von Dimensionswerten und Messwerten im Bericht.
totals[]

object (Row)

Auf Anfrage die Summen der Messwerte.
maximums[]

object (Row)

Auf Anfrage die Höchstwerte der Messwerte.
minimums[]

object (Row)

Auf Anfrage die Mindestwerte der 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 die API-Anfrage limit auf 50 festlegt, 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

Kennzeichnet, welche Art von Ressource diese Nachricht ist. 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

Eine zusammenhängende Menge von Minuten: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Anfragen sind auf maximal zwei Minutenbereiche beschränkt.

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

string

Weist diesem Minutenbereich einen Namen zu. Die Dimension dateRange wird in einer Berichtantwort auf diesen Namen festgelegt. Wenn festgelegt, darf der Name nicht mit date_range_ oder RESERVED_ beginnen. Wenn nicht festgelegt, werden Minutenbereiche anhand ihres nullbasierten Index in der Anfrage benannt: date_range_0, date_range_1 usw.
startMinutesAgo

integer

Die inklusive Startminute für die Abfrage als Anzahl der Minuten vor jetzt. Beispiel: "startMinutesAgo": 29 gibt an, dass der Bericht Ereignisdaten von vor 29 Minuten und danach enthalten soll. Darf nicht nach endMinutesAgo liegen.

Wenn nicht angegeben, wird startMinutesAgo standardmäßig auf 29 festgelegt. Standard-Analytics-Properties können Ereignisdaten der letzten 30 Minuten anfordern (startMinutesAgo <= 29). Für 360-Analytics-Properties sind Ereignisdaten der letzten 60 Minuten möglich (startMinutesAgo <= 59).
endMinutesAgo

integer

Die inklusive Endminute für die Abfrage als Anzahl der Minuten vor jetzt. Darf nicht vor startMinutesAgo liegen. Beispiel: "endMinutesAgo": 15 gibt an, dass der Bericht Ereignisdaten von vor 15 Minuten enthalten soll.

Wenn nicht angegeben, wird endMinutesAgo standardmäßig auf 0 festgelegt. Standard-Analytics-Properties können Ereignisdaten für jede Minute der letzten 30 Minuten anfordern (endMinutesAgo <= 29). Für 360-Analytics-Properties sind Ereignisdaten für jede Minute der letzten 60 Minuten möglich (endMinutesAgo <= 59).