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, события которого отслеживаются. Указывается в пути URL-адреса, а не в теле запроса. Для получения дополнительной информации см. раздел «Где найти идентификатор объекта недвижимости» .

Пример: properties/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-запросу having-clause. В этом фильтре нельзя использовать измерения.

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

Определяет, следует ли возвращать текущее состояние квоты в реальном времени для данного ресурса Google 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 )

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

metricHeaders[]

object ( MetricHeader )

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

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 )

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

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. Стандартные свойства Analytics могут запрашивать данные о событиях за последние 30 минут ( startMinutesAgo <= 29 ), а свойства 360 Analytics — за последние 60 минут ( startMinutesAgo <= 59 ).

endMinutesAgo

integer

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

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