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!

Hier erhalten Sie einen benutzerdefinierten Bericht mit Echtzeit-Ereignisdaten für Ihre Property. Ereignisse werden in Echtzeitberichten Sekunden nach ihrer Übermittlung an Google Analytics angezeigt. In Echtzeitberichten werden Ereignisse und Nutzungsdaten für einen bestimmten Zeitraum angezeigt, der vom aktuellen Zeitpunkt bis zu den letzten 30 Minuten reicht (bei Google Analytics 360-Properties bis zu 60 Minuten).

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

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 die Property-ID finden Beispiel: properties/1234

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 die Property-ID finden

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 und angezeigten Abmessungen.
`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 Post-Aggregationsphase angewendet, ähnlich wie bei SQL mit Klausel. In diesem Filter können keine Dimensionen verwendet werden.
`limit`	`string (int64 format)` Die Anzahl der zurückzugebenden Zeilen. Wenn kein Wert angegeben ist, werden 10.000 Zeilen zurückgegeben. Die API gibt maximal 250.000 Zeilen pro Anfrage zurück,unabhängig davon, wie viele Zeilen Sie anfordern. `limit` muss positiv sein. Die API kann auch weniger Zeilen als vom angeforderten `limit` zurückgeben, wenn nicht so viele Dimensionswerte wie `limit` vorhanden sind. Wenn beispielsweise für die Dimension „`country`“ weniger als 300 Werte möglich sind, können Sie bei Berichten nur für `country` maximal 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)“ festgelegt ist.
`orderBys[]`	`object (OrderBy)` Gibt an, wie Zeilen in der Antwort sortiert werden.
`returnPropertyQuota`	`boolean` Gibt an, ob der aktuelle Status des Echtzeitkontingents dieser Analytics-Property zurückgegeben werden soll. Das Kontingent wird in PropertyQuota zurückgegeben.
`minuteRanges[]`	`object (MinuteRange)` Die Minutenbereiche der zu lesenden Ereignisdaten. Wenn keine Vorgabe erfolgt, 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 Minutenbereiche überschneiden, werden die Ereignisdaten für die sich überschneidenden Minuten in die Antwortzeilen beider Minutenbereiche eingefügt.

Antworttext

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

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

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 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 Dimensionswertkombinationen und Messwerten im Bericht.
`totals[]`	`object (Row)` Falls angefordert, die Gesamtwerte der Messwerte.
`maximums[]`	`object (Row)` Falls angefordert, die Maximalwerte von Messwerten.
`minimums[]`	`object (Row)` Falls angefordert, die Mindestwerte von Messwerten.
`rowCount`	`integer` Die Gesamtzahl der Zeilen im Abfrageergebniss. `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 für `limit` den Wert 50 enthält, enthält die Antwort `rowCount` von 175, 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 sind für Zeiträume von bis zu 2 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 mit diesem Namen bewertet. Wenn festgelegt, darf sie nicht mit `date_range_` oder `RESERVED_` beginnen. Wenn nicht festgelegt, werden Minutenbereiche nach ihrem nullbasierten Index in der Anfrage benannt: `date_range_0`, `date_range_1` usw.
`startMinutesAgo`	`integer` Die Startminute für die Abfrage als Anzahl der Minuten vor dem aktuellen Datum. So gibt `"startMinutesAgo": 29` an, dass der Bericht Ereignisdaten enthalten soll, die 29 Minuten zurückliegen. Darf nicht nach dem `endMinutesAgo` liegen. Wenn keine Vorgabe erfolgt, wird `startMinutesAgo` standardmäßig auf 29 gesetzt. Für Standard-Analytics-Properties können Ereignisdaten aus den letzten 30 Minuten angefordert werden (`startMinutesAgo <= 29`), für Analytics-Properties der letzten 60 Minuten (`startMinutesAgo <= 59`).
`endMinutesAgo`	`integer` Die inklusive Endminute für die Abfrage als Anzahl der Minuten vor dem aktuellen Datum. Darf nicht vor dem `startMinutesAgo` liegen. `"endMinutesAgo": 15` gibt beispielsweise an, dass der Bericht Ereignisdaten enthalten soll, die maximal 15 Minuten zurückliegen. Wenn keine Vorgabe erfolgt, wird `endMinutesAgo` standardmäßig auf 0 gesetzt. Analytics-Standard-Properties können jede Minute in den letzten 30 Minuten für Ereignisdaten anfordern (`endMinutesAgo <= 29`), 360-Analytics-Properties können jede Minute der Ereignisdaten in den letzten 60 Minuten anfordern (`endMinutesAgo <= 59`).

name

string

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

startMinutesAgo

integer

Die Startminute für die Abfrage als Anzahl der Minuten vor dem aktuellen Datum. So gibt "startMinutesAgo": 29 an, dass der Bericht Ereignisdaten enthalten soll, die 29 Minuten zurückliegen. Darf nicht nach dem endMinutesAgo liegen.

Wenn keine Vorgabe erfolgt, wird startMinutesAgo standardmäßig auf 29 gesetzt. Für Standard-Analytics-Properties können Ereignisdaten aus den letzten 30 Minuten angefordert werden (startMinutesAgo <= 29), für Analytics-Properties der letzten 60 Minuten (startMinutesAgo <= 59).

endMinutesAgo

integer

Die inklusive Endminute für die Abfrage als Anzahl der Minuten vor dem aktuellen Datum. Darf nicht vor dem startMinutesAgo liegen. "endMinutesAgo": 15 gibt beispielsweise an, dass der Bericht Ereignisdaten enthalten soll, die maximal 15 Minuten zurückliegen.

Wenn keine Vorgabe erfolgt, wird endMinutesAgo standardmäßig auf 0 gesetzt. Analytics-Standard-Properties können jede Minute in den letzten 30 Minuten für Ereignisdaten anfordern (endMinutesAgo <= 29), 360-Analytics-Properties können jede Minute der Ereignisdaten in den letzten 60 Minuten anfordern (endMinutesAgo <= 59).