Method: properties.runReport

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

HTTP-запрос

POST https://analyticsdata.googleapis.com/v1alpha/{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)
    }
  ],
  "conversionSpec": {
    object (ConversionSpec)
  }
}
Поля
dimensions[]

object ( Dimension )

Необязательно. Запрашиваемые и отображаемые размеры.

metrics[]

object ( Metric )

Необязательно. Запрашиваемые и отображаемые метрики.

dateRanges[]

object ( DateRange )

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

dimensionFilter

object ( FilterExpression )

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

metricFilter

object ( FilterExpression )

Необязательный параметр. Это условие фильтрации метрик. Применяется после агрегирования строк отчета, аналогично условию SQL having. В этом фильтре нельзя использовать измерения.

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 на более высокое значение.

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

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 )

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

conversionSpec

object ( ConversionSpec )

Необязательно. Управляет формированием отчетов по конверсиям. Это поле необязательно. Если это поле задано или запрашиваются какие-либо показатели конверсии, будет сформирован отчет по конверсиям.

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

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

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

JSON-представление 
{
  "dimensionHeaders": [
    {
      object (DimensionHeader)
    }
  ],
  "metricHeaders": [
    {
      object (MetricHeader)
    }
  ],
  "rows": [
    {
      object (Row)
    }
  ],
  "totals": [
    {
      object (Row)
    }
  ],
  "maximums": [
    {
      object (Row)
    }
  ],
  "minimums": [
    {
      object (Row)
    }
  ],
  "rowCount": integer,
  "metadata": {
    object (ResponseMetaData)
  },
  "propertyQuota": {
    object (PropertyQuota)
  },
  "kind": string,
  "nextPageToken": string
}
Поля
dimensionHeaders[]

object ( DimensionHeader )

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

metricHeaders[]

object ( MetricHeader )

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

rows[]

object ( Row )

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

totals[]

object ( Row )

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

maximums[]

object ( Row )

При необходимости указываются максимальные значения метрик.

minimums[]

object ( Row )

При необходимости указываются минимальные значения метрик.

rowCount

integer

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

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

metadata

object ( ResponseMetaData )

Метаданные для отчета.

propertyQuota

object ( PropertyQuota )

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

kind

string

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

nextPageToken

string

Токен, который можно отправить в качестве pageToken для получения следующей страницы. Если это поле опущено, последующих страниц не будет.

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

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

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

Сравнение

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

JSON-представление 
{
  "name": string,

  // Union field one_comparison can be only one of the following:
  "dimensionFilter": {
    object (FilterExpression)
  },
  "comparison": string
  // End of list of possible types for union field one_comparison.
}
Поля
name

string

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

Объединенное поле one_comparison .

one_comparison может принимать только одно из следующих значений:

dimensionFilter

object ( FilterExpression )

Простое сравнение.

comparison

string

Сохраненное сравнение, идентифицированное по имени ресурса сравнения. Например, 'comparisons/1234'.

ConversionSpec

Управление формированием отчетов о конверсиях.

JSON-представление 
{
  "conversionActions": [
    string
  ],
  "attributionModel": enum (AttributionModel)
}
Поля
conversionActions[]

string

Идентификаторы действий по конверсии, которые следует включить в отчет. Если поле пустое, включаются все конверсии. Действительные идентификаторы действий по конверсии можно получить из поля conversionAction в списке conversions в ответе метода properties.getMetadata . Например, 'conversionActions/1234'.

attributionModel

enum ( AttributionModel )

Модель атрибуции, используемая в отчете о конверсиях. Если не указана, используется DATA_DRIVEN .

Модель атрибуции

Модель атрибуции для использования в отчете о конверсиях.

Перечисления
ATTRIBUTION_MODEL_UNSPECIFIED Модель атрибуции не указана.
DATA_DRIVEN Атрибуция основывалась на модели, учитывающей платные и органические продажи.
LAST_CLICK Атрибуция основывалась на модели "последний клик" для платных и органических результатов.