Method: properties.runPivotReport

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

HTTP-запрос

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

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

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

Параметры
property

string

Идентификатор ресурса Google Analytics, события которого отслеживаются. Указывается в URL-пути, а не в теле. Чтобы узнать больше, посмотрите , где найти свой идентификатор объекта . В пакетном запросе это свойство должно быть либо неопределенным, либо соответствовать свойству уровня пакета.

Пример: свойства/1234

Тело запроса

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

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

object ( Dimension )

Запрошенные размеры. Все определенные измерения должны использоваться одним из следующих элементов: DimensionExpression, DimensionFilter, Pivots, OrderBys.

metrics[]

object ( Metric )

Запрошенные метрики. Необходимо указать хотя бы одну метрику. Все определенные метрики должны использоваться одним из следующих: metric_expression, metricFilter, orderBys.

date Ranges[]

object ( DateRange )

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

pivots[]

object ( Pivot )

Описывает визуальный формат измерений отчета в столбцах или строках. Объединение полейNames (имен измерений) во всех сводных таблицах должно представлять собой подмножество имен измерений, определенных в разделе Измерения. Никакие две точки поворота не могут иметь одно и то же измерение. Измерение отображается только в том случае, если оно отображается в центре.

dimension Filter

object ( FilterExpression )

Предложение фильтра измерений. Для использования в этом фильтре необходимо запросить размеры. В этом фильтре нельзя использовать метрики.

metric Filter

object ( FilterExpression )

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

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 )

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

Тело ответа

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

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

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

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