Method: properties.runRealtimeReport

Über die Google Analytics Realtime API wird ein benutzerdefinierter Bericht mit Echtzeitereignisdaten für Ihre Property zurückgegeben. Diese Berichte enthalten Ereignisse und Nutzungsdaten der letzten 30 Minuten.

HTTP-Anfrage

POST https://analyticsdata.googleapis.com/v1alpha/{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)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
Felder
dimensions[]

object (Dimension)

Die angeforderten und angezeigten Dimensionen.
metrics[]

object (Metric)

Die angeforderten und angezeigten Messwerte.
limit

string (int64 format)

Die Anzahl der zurückzugebenden Zeilen. Wenn der Parameter limit nicht angegeben ist, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 100.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Zeilen angefordert werden.
dimensionFilter

object (FilterExpression)

Die Filterklausel von Dimensionen. Dimensionen müssen angefordert werden, damit sie in diesem Filter verwendet werden können. 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. Messwerte müssen angefordert werden, damit sie in diesem Filter verwendet werden können. In diesem Filter können keine Dimensionen verwendet werden.
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.

Antworttext

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

Die Echtzeitberichtstabelle für Antworten, die einer Anfrage entspricht.

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)
  }
}
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, unabhängig von der Anzahl der in der Antwort zurückgegebenen Zeilen. Beispiel: Wenn eine Abfrage 175 Zeilen zurückgibt und die API-Anfrage ein Limit von 50 enthält, enthält die Antwort rowCount = 175, aber nur 50 Zeilen.
propertyQuota

object (PropertyQuota)

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

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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