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-пути, а не в теле. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта . В пакетном запросе это свойство должно быть либо неопределенным, либо соответствовать свойству уровня пакета.

Пример: свойства/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 )

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

date Ranges[]

object ( DateRange )

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

dimension Filter

object ( FilterExpression )

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

metric Filter

object ( FilterExpression )

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

offset

string ( int64 format)

Количество строк в начальной строке. Первая строка считается строкой 0.

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

Дополнительные сведения об этом параметре нумерации страниц см. в разделе Нумерация страниц .

limit

string ( int64 format)

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

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

Дополнительные сведения об этом параметре нумерации страниц см. в разделе Нумерация страниц .

metric Aggregations[]

enum ( MetricAggregation )

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

order Bys[]

object ( OrderBy )

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

currency Code

string

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

cohort Spec

object ( CohortSpec )

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

keep Empty Rows

boolean

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

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

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

return Property Quota

boolean

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

comparisons[]

object ( Comparison )

Необязательный. Конфигурация сравнений запрошена и отображена. Запросу требуется только поле сравнения, чтобы получить столбец сравнения в ответе.

Тело ответа

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

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

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

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