Method: properties.runRealtimeReport

Возвращает настроенный отчет с данными о событиях в реальном времени для вашего объекта. События появляются в отчетах в реальном времени через несколько секунд после их отправки в Google Analytics. В отчетах в реальном времени отображаются события и данные об использовании за периоды времени от настоящего момента до 30 минут назад (до 60 минут для ресурсов Google Analytics 360).

Руководство по созданию запросов в реальном времени и пониманию ответов см. в разделе Создание отчета в реальном времени .

HTTP-запрос

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

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

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

Параметры
property

string

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

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

Тело запроса

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

JSON-представление 
{
  "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 )

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

limit

string ( int64 format)

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

API также может возвращать меньше строк, чем запрошенное limit , если значений измерения не так много, как limit . Например, для параметра country существует менее 300 возможных значений, поэтому при составлении отчета только country вы не сможете получить более 300 строк, даже если вы установите limit на более высокое значение.

metricAggregations[]

enum ( MetricAggregation )

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

orderBys[]

object ( OrderBy )

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

returnPropertyQuota

boolean

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

minuteRanges[]

object ( MinuteRange )

Минутные диапазоны данных о событиях для чтения. Если не указано, будет использоваться диапазон в одну минуту за последние 30 минут. Если запрошено несколько диапазонов минут, каждая строка ответа будет содержать индекс минутного диапазона, отсчитываемый от нуля. Если два минутных диапазона перекрываются, данные о событиях для перекрывающихся минут включаются в строки ответов для обоих минутных диапазонов.

Тело ответа

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

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

JSON-представление 
{
  "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 )

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

metricHeaders[]

object ( MetricHeader )

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

rows[]

object ( Row )

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

totals[]

object ( Row )

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

maximums[]

object ( Row )

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

minimums[]

object ( Row )

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

rowCount

integer

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

propertyQuota

object ( PropertyQuota )

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

kind

string

Определяет, к какому типу ресурса относится это сообщение. Этот kind всегда представляет собой фиксированную строку «analyticsData#runRealtimeReport». Полезно различать типы ответов в JSON.

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

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

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

Минутный диапазон

Непрерывный набор минут: startMinutesAgo , startMinutesAgo + 1 , ..., endMinutesAgo . Запросы разрешены в диапазоне до 2 минут.

JSON-представление 
{
  "name": string,
  "startMinutesAgo": integer,
  "endMinutesAgo": integer
}
Поля
name

string

Присваивает имя этому минутному диапазону. Измерение dateRange оценивается по этому имени в ответе отчета. Если установлено, не может начинаться с date_range_ или RESERVED_ . Если этот параметр не установлен, минутные диапазоны именуются по индексу, начинающемуся с нуля, в запросе: date_range_0 , date_range_1 и т. д.

startMinutesAgo

integer

Включающая минута начала запроса как количество минут до текущего момента. Например, "startMinutesAgo": 29 указывает, что отчет должен включать данные о событиях, произошедших 29 минут назад и позже. Не может быть после endMinutesAgo .

Если значение не указано, startMinutesAgo по умолчанию имеет значение 29. Свойства Standard Analytics могут запрашивать данные о событиях за последние 30 минут ( startMinutesAgo <= 29 ), а свойства 360 Analytics могут запрашивать данные о событиях за последние 60 минут ( startMinutesAgo <= 59 ).

endMinutesAgo

integer

Включающая минута окончания запроса как количество минут до текущего момента. Не может быть раньше startMinutesAgo . Например, "endMinutesAgo": 15 указывает, что отчет должен включать данные о событиях, произошедших менее 15 минут назад.

Если параметр не указан, endMinutesAgo по умолчанию имеет значение 0. Свойства Standard Analytics могут запрашивать данные о событиях в любую минуту за последние 30 минут ( endMinutesAgo <= 29 ), а свойства 360 Analytics могут запрашивать данные о событиях в любую минуту за последние 60 минут ( endMinutesAgo <= 59 ).