API Google Analytics Realtime возвращает настроенный отчет с данными о событиях в реальном времени для вашего ресурса. В этих отчетах показаны события и использование за последние 30 минут.
HTTP-запрос
POST https://analyticsdata.googleapis.com/v1alpha/{property=properties/*}:runRealtimeReport
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
property | Идентификатор ресурса Google Analytics GA4, события которого отслеживаются. Указывается в URL-пути, а не в теле. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта . Пример: свойства/1234 |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление | |
---|---|
{ "dimensions": [ { object ( |
Поля | |
---|---|
dimensions[] | Запрошенные и отображенные размеры. |
metrics[] | Запрошенные и отображаемые метрики. |
limit | Количество возвращаемых строк. Если параметр |
dimensionFilter | Предложение фильтра измерений. Для использования в этом фильтре необходимо запросить размеры. В этом фильтре нельзя использовать метрики. |
metricFilter | Предложение фильтра метрик. Применяется на этапе после агрегирования, аналогично предложению «имеет» в SQL. Метрики должны быть запрошены для использования в этом фильтре. В этом фильтре нельзя использовать размеры. |
metricAggregations[] | Агрегация метрик. Агрегированные значения показателей будут отображаться в строках, где для параметра DimensionValues установлено значение «RESERVED_(MetricAggregation)». |
orderBys[] | Указывает, как упорядочены строки в ответе. |
returnPropertyQuota | Переключает, возвращать ли текущее состояние квоты реального времени этого ресурса Analytics. Квота возвращается в PropertyQuota . |
Тело ответа
В случае успеха тело ответа содержит данные следующей структуры:
Таблица отчета ответа в реальном времени, соответствующая запросу.
JSON-представление | |
---|---|
{ "dimensionHeaders": [ { object ( |
Поля | |
---|---|
dimensionHeaders[] | Описывает столбцы измерений. Количество DimensionHeaders и порядок DimensionHeaders соответствуют измерениям, представленным в строках. |
metricHeaders[] | Описывает столбцы показателей. Количество MetricHeaders и порядок MetricHeaders соответствуют метрикам, представленным в строках. |
rows[] | Строки комбинаций значений измерений и значений показателей в отчете. |
totals[] | По запросу — суммарные значения метрик. |
maximums[] | По запросу максимальные значения метрик. |
minimums[] | По запросу — минимальные значения метрик. |
rowCount | Общее количество строк в результате запроса независимо от количества строк, возвращенных в ответе. Например, если запрос возвращает 175 строк и включает в запрос API limit = 50, ответ будет содержать rowCount = 175, но только 50 строк. |
propertyQuota | Состояние квоты этого аналитического ресурса в реальном времени, включая этот запрос. |
Области авторизации
Требуется одна из следующих областей OAuth:
-
https://www.googleapis.com/auth/analytics.readonly
-
https://www.googleapis.com/auth/analytics