Method: properties.batchRunPivotReports

Возвращает несколько сводных отчетов в пакетном режиме. Все отчеты должны относиться к одному и тому же ресурсу Google Analytics.

HTTP-запрос

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

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

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

Параметры
property

string

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

Пример: properties/1234

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

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

JSON-представление 
{
  "requests": [
    {
      object (RunPivotReportRequest)
    }
  ]
}
Поля
requests[]

object ( RunPivotReportRequest )

Индивидуальные запросы. Для каждого запроса формируется отдельный ответ в виде сводного отчета. В рамках одной пакетной обработки может быть выполнено до 5 запросов.

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

Пакетный ответ, содержащий несколько сводных отчетов.

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

JSON-представление 
{
  "pivotReports": [
    {
      object (RunPivotReportResponse)
    }
  ],
  "kind": string
}
Поля
pivotReports[]

object ( RunPivotReportResponse )

Индивидуальные ответы. Для каждого ответа требуется отдельный запрос на создание сводного отчета.

kind

string

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

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

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

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

RunPivotReportRequest

Запрос на создание сводного отчета.

JSON-представление 
{
  "property": string,
  "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)
    }
  ]
}
Поля
property

string

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

Пример: properties/1234

dimensions[]

object ( Dimension )

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

metrics[]

object ( Metric )

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

dateRanges[]

object ( DateRange )

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

pivots[]

object ( Pivot )

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

dimensionFilter

object ( FilterExpression )

Фильтрующий параметр для измерений. Для использования в этом фильтре необходимо запросить измерения. Метрики в этом фильтре использовать нельзя.

metricFilter

object ( FilterExpression )

Фильтрующий параметр метрик. Применяется на этапе пост-агрегации, аналогично SQL-запросу having-clause. Для использования в этом фильтре метрики должны быть запрошены. Измерения в этом фильтре использовать нельзя.

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 )

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