Diese Seite wurde von der Cloud Translation API übersetzt.

Method: properties.runRealtimeReport

HTTP-Anfrage
Pfadparameter
Anfragetext
- JSON-Darstellung
Antworttext
- JSON-Darstellung
Autorisierungsbereiche
MinuteRange
- JSON-Darstellung
Testen!

Gibt einen benutzerdefinierten Bericht mit Echtzeit-Ereignisdaten 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 einen Zeitraum zwischen dem aktuellen Moment und 30 Minuten (für Google Analytics 360-Properties bis zu 60 Minuten).

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

Parameter
`property`	`string` Eine GA4-Property-ID, deren Ereignisse erfasst werden. Sie wird im URL-Pfad und nicht im Text angegeben. Weitere Informationen zum Ermitteln der Property-ID Beispiel: properties/1234

property

string

Eine GA4-Property-ID, deren Ereignisse erfasst werden. Sie 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

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`) } ] }

{
  "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 Dimensionen werden angezeigt.
`metrics[]`	`object (Metric)` Die angeforderten und angezeigten Messwerte.
`dimensionFilter`	`object (FilterExpression)` Die Filterklausel mit den Dimensionen. In diesem Filter können keine Messwerte verwendet werden.
`metricFilter`	`object (FilterExpression)` Die Filterklausel mit Messwerten. Wird nach der Zusammenfassung angewendet, ähnlich wie bei der SQL-Klausel. In diesem Filter können keine Dimensionen verwendet werden.
`limit`	`string (int64 format)` Die Anzahl der zurückzugebenden Zeilen. Wenn keine Angabe erfolgt, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 100.000 Zeilen pro Anfrage 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 `limit` gibt. Beispielsweise gibt es weniger als 300 mögliche Werte für die Dimension `country`. Wenn Sie also nur Berichte zu `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)“ gesetzt ist.
`orderBys[]`	`object (OrderBy)` Gibt an, wie Zeilen in der Antwort angeordnet sind.
`returnPropertyQuota`	`boolean` Gibt an, ob der aktuelle Status des Echtzeitkontingents für diese Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyKontingent zurückgegeben.
`minuteRanges[]`	`object (MinuteRange)` Die Minutenbereiche der zu lesenden Ereignisdaten. Wenn keine Angabe erfolgt, wird ein Minutenbereich der letzten 30 Minuten verwendet. Wenn mehrere Minutenbereiche angefordert werden, enthält jede Antwortzeile einen nullbasierten Minutenbereichindex. Wenn sich zwei Minuten überschneiden, werden die Ereignisdaten für die sich überschneidenden Minuten in den Antwortzeilen für beide Minutenbereiche angezeigt.

Antworttext

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

Tabelle mit Echtzeitdaten zur Antwort, die einer Anfrage entspricht.

JSON-Darstellung

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 }

{
  "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 DimensionHeader und die Reihenfolge der DimensionHeaders entsprechen den Abmessungen in Zeilen.
`metricHeaders[]`	`object (MetricHeader)` Beschreibt Messwertspalten. Die Anzahl der MetrikHeader und die Reihenfolge der MetrikHeader entsprechen den Metriken, die in den Zeilen vorhanden sind.
`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)` Auf Anfrage die Mindestwerte von Messwerten.
`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 der API-Anfrage enthalten ist, enthält die Antwort `rowCount` von 175, aber nur 50 Zeilen.
`propertyQuota`	`object (PropertyQuota)` Der Kontingentstatus der Analytics-Property, einschließlich dieser Anfrage.
`kind`	`string` Gibt die Art der Ressource an. Diese `kind` ist immer der feste String "analyticsData#runRealtimeReport". Nützlich, um zwischen JSON-Antworttypen zu unterscheiden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Minutenbereich

Mehrere aufeinanderfolgende Minuten: startMinutesAgo, startMinutesAgo + 1, ..., endMinutesAgo. Anfragen sind bis zu zwei Minuten zulässig.

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

Felder

Felder
`name`	`string` Weist diesem Minutenbereich einen Namen zu. Die Dimension „`dateRange`“ wird in einer Berichtsantwort auf diesen Namen gesetzt. Wenn dieses Attribut festgelegt ist, darf es nicht mit `date_range_` oder `RESERVED_` beginnen. Wenn nicht festgelegt, werden Minutenbereiche in der Anfrage nach ihrem nullbasierten Index benannt: `date_range_0`, `date_range_1` usw.
`startMinutesAgo`	`integer` Die inklusive Startzeit für die Abfrage als Anzahl der Minuten vor dem aktuellen Zeitpunkt. Beispiel: `"startMinutesAgo": 29` gibt an, dass der Bericht Ereignisdaten der letzten 29 Minuten enthalten soll. Darf nicht nach dem `endMinutesAgo` liegen. Wenn kein Wert angegeben ist, wird standardmäßig `startMinutesAgo` verwendet. Mit standardmäßigen Analytics-Properties können Sie Ereignisdaten der letzten 30 Minuten (`startMinutesAgo <= 29`) und mit 360 Analytics-Properties bis zu 60 Minuten von Ereignisdaten (`startMinutesAgo <= 59`) anfordern.
`endMinutesAgo`	`integer` Die inklusive Endzeit für die Abfrage als Anzahl der Minuten vor dem aktuellen Zeitpunkt. Darf nicht vor dem `startMinutesAgo` liegen. Beispiel: `"endMinutesAgo": 15` gibt an, dass der Bericht Ereignisdaten der letzten 15 Minuten enthalten soll. Wenn kein Wert angegeben ist, wird standardmäßig `endMinutesAgo` verwendet. In Analytics-Standard-Properties können Sie jede Minute in den Ereignisdaten der letzten 30 Minuten (`endMinutesAgo <= 29`) und in 360-Analytics-Properties eine beliebige Minute in den Ereignisdaten (`endMinutesAgo <= 59`) anfordern.

name

string

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

startMinutesAgo

integer

Die inklusive Startzeit für die Abfrage als Anzahl der Minuten vor dem aktuellen Zeitpunkt. Beispiel: "startMinutesAgo": 29 gibt an, dass der Bericht Ereignisdaten der letzten 29 Minuten enthalten soll. Darf nicht nach dem endMinutesAgo liegen.

Wenn kein Wert angegeben ist, wird standardmäßig startMinutesAgo verwendet. Mit standardmäßigen Analytics-Properties können Sie Ereignisdaten der letzten 30 Minuten (startMinutesAgo <= 29) und mit 360 Analytics-Properties bis zu 60 Minuten von Ereignisdaten (startMinutesAgo <= 59) anfordern.

endMinutesAgo

integer

Die inklusive Endzeit für die Abfrage als Anzahl der Minuten vor dem aktuellen Zeitpunkt. Darf nicht vor dem startMinutesAgo liegen. Beispiel: "endMinutesAgo": 15 gibt an, dass der Bericht Ereignisdaten der letzten 15 Minuten enthalten soll.

Wenn kein Wert angegeben ist, wird standardmäßig endMinutesAgo verwendet. In Analytics-Standard-Properties können Sie jede Minute in den Ereignisdaten der letzten 30 Minuten (endMinutesAgo <= 29) und in 360-Analytics-Properties eine beliebige Minute in den Ereignisdaten (endMinutesAgo <= 59) anfordern.