Method: properties.runRealtimeReport

API Google Analytics Realtime возвращает настроенный отчет с данными о событиях в реальном времени для вашего ресурса. В этих отчетах показаны события и использование за последние 30 минут.

HTTP-запрос

POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runRealtimeReport

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
property

string

Идентификатор ресурса Google Analytics GA4, события которого отслеживаются. Указывается в URL-пути, а не в теле. Чтобы узнать больше, узнайте , где найти свой идентификатор объекта .

Пример: свойства/1234

Тело запроса

Тело запроса содержит данные следующей структуры:

JSON-представление 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "limit": string,
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "returnPropertyQuota": boolean
}
Поля
dimensions[]

object ( Dimension )

Запрошенные и отображенные размеры.

metrics[]

object ( Metric )

Запрошенные и отображаемые метрики.

limit

string ( int64 format)

Количество возвращаемых строк. Если параметр limit не указан, возвращается 10 000 строк. API возвращает максимум 100 000 строк на запрос, независимо от того, сколько вы запрашиваете.

dimensionFilter

object ( FilterExpression )

Предложение фильтра измерений. Для использования в этом фильтре необходимо запросить размеры. В этом фильтре нельзя использовать метрики.

metricFilter

object ( FilterExpression )

Предложение фильтра метрик. Применяется на этапе после агрегирования, аналогично предложению «имеет» в SQL. Метрики должны быть запрошены для использования в этом фильтре. В этом фильтре нельзя использовать размеры.

metricAggregations[]

enum ( MetricAggregation )

Агрегация метрик. Агрегированные значения показателей будут отображаться в строках, где для параметра DimensionValues ​​установлено значение «RESERVED_(MetricAggregation)».

orderBys[]

object ( OrderBy )

Указывает, как упорядочены строки в ответе.

returnPropertyQuota

boolean

Переключает, возвращать ли текущее состояние квоты реального времени этого ресурса Analytics. Квота возвращается в PropertyQuota .

Тело ответа

В случае успеха тело ответа содержит данные следующей структуры:

Таблица отчета ответа в реальном времени, соответствующая запросу.

JSON-представление 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "propertyQuota": {
    object (PropertyQuota)
  }
}
Поля
dimensionHeaders[]

object ( DimensionHeader )

Описывает столбцы измерений. Количество DimensionHeaders и порядок DimensionHeaders соответствуют измерениям, представленным в строках.

metricHeaders[]

object ( MetricHeader )

Описывает столбцы показателей. Количество MetricHeaders и порядок MetricHeaders соответствуют метрикам, представленным в строках.

rows[]

object ( Row )

Строки комбинаций значений измерений и значений показателей в отчете.

totals[]

object ( Row )

По запросу — суммарные значения метрик.

maximums[]

object ( Row )

По запросу максимальные значения метрик.

minimums[]

object ( Row )

По запросу — минимальные значения метрик.

rowCount

integer

Общее количество строк в результате запроса независимо от количества строк, возвращенных в ответе. Например, если запрос возвращает 175 строк и включает в запрос API limit = 50, ответ будет содержать rowCount = 175, но только 50 строк.

propertyQuota

object ( PropertyQuota )

Состояние квоты этого аналитического ресурса в реальном времени, включая этот запрос.

Области авторизации

Требуется одна из следующих областей OAuth:

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