Method: properties.runReport

Возвращает персонализированный отчет по данным о событиях Google Analytics. Отчеты содержат статистику, полученную на основе данных, собранных кодом отслеживания Google Analytics. Данные, возвращаемые API, представляют собой таблицу со столбцами для запрошенных измерений и показателей. Показатели — это отдельные измерения активности пользователей на вашем ресурсе, такие как количество активных пользователей или количество событий. Измерения позволяют разбить показатели по некоторым общим критериям, таким как страна или название события.

Инструкции по составлению запросов и анализу ответов см. в разделе «Создание отчета» .

HTTP-запрос

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

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

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

Параметры
property

string

Идентификатор ресурса Google Analytics, события которого отслеживаются. Указывается в пути URL-адреса, а не в теле запроса. Для получения дополнительной информации см. раздел «Где найти идентификатор ресурса» . В пакетном запросе это свойство должно быть либо не указано, либо соответствовать свойству на уровне пакета.

Пример: properties/1234

Текст запроса

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

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

object ( Dimension )

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

metrics[]

object ( Metric )

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

dateRanges[]

object ( DateRange )

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

dimensionFilter

object ( FilterExpression )

Фильтры по измерениям позволяют запрашивать в отчете только значения определенных измерений. Для получения дополнительной информации см. раздел «Основы использования фильтров по измерениям» с примерами. Метрики в этом фильтре использовать нельзя.

metricFilter

object ( FilterExpression )

Фильтрующий параметр метрик. Применяется после агрегирования строк отчета, аналогично SQL-запросу having-clause. В этом фильтре нельзя использовать измерения.

offset

string ( int64 format)

Номер строки в начале списка. Первая строка считается нулевой.

При постраничной навигации первый запрос не указывает смещение; или, эквивалентно, устанавливает смещение равным 0; первый запрос возвращает первое limit количества строк. Второй запрос устанавливает смещение равным limit первого запроса; второй запрос возвращает второе limit количества строк.

Чтобы узнать больше об этом параметре пагинации, см. раздел «Пагинация» .

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 )

Указывает, как упорядочиваются строки в ответе. Запросы, включающие как сравнения, так и несколько диапазонов дат, будут иметь сортировку по результатам сравнений.

currencyCode

string

Код валюты в формате ISO4217, например, "AED", "USD", "JPY". Если поле пустое, в отчете используется валюта по умолчанию для данного объекта.

cohortSpec

object ( CohortSpec )

Группа когорт, связанная с данным запросом. Если в запросе указана группа когорт, то должен присутствовать параметр «когорта».

keepEmptyRows

boolean

Если значение равно false или не указано, ни одна строка, у которой все метрики равны 0, не будет возвращена. Если значение равно true, эти строки будут возвращены, если они не будут удалены отдельно с помощью фильтра.

Независимо от параметра keepEmptyRows , в отчете будут отображаться только данные, записанные с помощью ресурса Google Analytics.

Например, если объект недвижимости никогда не регистрирует событие purchase , то запрос по измерению eventName и метрике eventCount не будет содержать строку eventName: "purchase" и eventCount: 0.

returnPropertyQuota

boolean

Определяет, следует ли возвращать текущее состояние квоты для данного ресурса Google Analytics. Квота возвращается в объекте PropertyQuota .

comparisons[]

object ( Comparison )

Необязательно. Настройки запрашиваемых и отображаемых сравнений. Для получения столбца сравнений в ответе достаточно указать поле «сравнения».

Ответный текст

В случае успеха тело ответа будет содержать экземпляр RunReportResponse .

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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