Google Analytics Data API версии 1 позволяет создавать сводные таблицы. Сводные таблицы – это инструмент обобщения данных, который позволяет визуализировать данные, перестраивая информацию в таблице путем поворота (вращения) данных по одному или нескольким параметрам.
В качестве примера рассмотрим следующую таблицу с первичными данными:

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

Функции, общие с основными отчетами
Запросы сводных отчетов имеют ту же семантику, что и запросы основных отчетов для многих общих функций. Например, разбиение на страницы, фильтры параметров и свойства пользователей работают в сводных отчетах так же, как и в основных. В этом руководстве рассматриваются функции сводных отчетов. Чтобы ознакомиться с основными функциями отчетов в Data API версии 1, прочитайте руководство по основам работы с отчетами и руководство по расширенным сценариям использования.
Методы сводных отчетов
Data API версии 1 поддерживает функцию сводки в следующих методах создания отчетов:
runPivotReport – этот метод возвращает настраиваемый сводный отчет о данных о событиях Google Аналитики. Каждая сводка описывает видимые столбцы и строки параметров в ответе отчета.
batchRunPivotReports – это пакетная версия метода
runPivotReport, которая позволяет создавать несколько отчетов с помощью одного вызова API.
Выберите объект отчета
Для всех методов Data API v1 требуется указать идентификатор ресурса Google Аналитики в пути запроса URL в формате properties/GA_PROPERTY_ID, например:
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runPivotReport
Отчет будет создан на основе данных о событиях Google Аналитики, собранных в указанном ресурсе Google Аналитики.
Если вы используете одну из клиентских библиотек Data API, вам не нужно вручную изменять путь URL запроса. Большинство API-клиентов предоставляют параметр property, который ожидает строку в формате properties/GA_PROPERTY_ID. Примеры использования клиентских библиотек приведены в кратком руководстве.
Запрос сводного отчета
Чтобы создать запрос со сводной таблицей, используйте метод runPivotReport или batchRunPivotReports.
Чтобы запросить сводные данные, создайте объект RunPivotReportRequest. Рекомендуем начать со следующих параметров запроса:
- Допустимое значение в поле dateRanges.
- Хотя бы одно допустимое значение в поле dimensions.
- В поле metrics должно присутствовать хотя бы одно допустимое значение.
- В поле pivots должно быть не менее двух допустимых записей.
Ниже приведен пример запроса с рекомендуемыми полями.
HTTP
POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runPivotReport
{
"dateRanges": [{ "startDate": "2020-09-01", "endDate": "2020-09-15" }],
"dimensions": [
{ "name": "browser" },
{ "name": "country" },
{ "name": "language" }
],
"metrics": [{ "name": "sessions" }],
"pivots": [
{
"fieldNames": [
"browser"
],
"limit": 5
},
{
"fieldNames": [
"country"
],
"limit": 250
},
{
"fieldNames": [
"language"
],
"limit": 15
}
]
}
Сводки
Чтобы определить сводки отчета, используйте объекты Pivot в поле pivot тела запроса. Каждый объект Pivot описывает видимые столбцы и строки параметров в ответе отчета.
Data API версии 1 поддерживает несколько сводок,если произведение параметра limit для каждой сводки не превышает 100 000.
В следующем фрагменте кода показано, как использовать pivots для создания отчета о количестве сеансов по странам, сведенного по параметру browser. Обратите внимание, что в запросе используется поле orderBys для сортировки, а также поля limit и offset для разбивки на страницы.
"pivots": [
{
"fieldNames": [
"country"
],
"limit": 250,
"orderBys": [
{
"dimension": {
"dimensionName": "country"
}
}
]
},
{
"fieldNames": [
"browser"
],
"offset": 3,
"limit": 3,
"orderBys": [
{
"metric": {
"metricName": "sessions"
},
"desc": true
}
]
}
],
...
Размеры
Параметры описывают и группируют данные о событиях на вашем сайте или в приложении. Например, параметр city указывает город, в котором произошло событие (например, Париж или Нью-Йорк). В запросе отчета можно указать любое количество параметров.
Параметры должны быть определены в поле dimensions тела запроса. Чтобы эти параметры были видны в отчете, они также должны быть перечислены в поле fieldNames объекта Pivot.
Параметр не будет виден в отчете, если он не используется ни в одном сводном запросе. Не все параметры должны быть представлены в fieldNames сводки. Параметры можно использовать только в фильтрах, но не в fieldNames сводной таблицы.
В следующем фрагменте кода показано, как использовать поля dimension и fieldNames для таблицы со сводными столбцами browser, country и language:
"pivots": [
{
"fieldNames": [
"browser"
],
"limit": 5,
"orderBys": [
{
"metric": {
"metricName": "sessions"
},
"desc": true
}
]
},
{
"fieldNames": [
"country"
],
"limit": 250,
"orderBys": [
{
"dimension": {
"dimensionName": "country"
}
}
]
},
{
"fieldNames": [
"language"
],
"limit": 10
}
],
Показатели
Показатели – это количественные измерения данных о событиях на сайте или в приложении. В запросе отчета можно указать один или несколько показателей. Полный список показателей API, которые можно указывать в запросах, приведен в статье Показатели API.
В запросах сводных отчетов показатели определяются с помощью поля metrics тела запроса, аналогично методам Core Reporting.
В следующем примере в качестве значения показателя в отчете используется количество сеансов:
"metrics": [
{
"name": "sessions"
}
],
Агрегирование показателей
Используйте поле metricAggregations объекта Pivot, чтобы рассчитать агрегированные значения показателей для каждой сводки.
Агрегированные показатели рассчитываются, только если в запросе задано поле metricAggregations.
Ниже приведен пример фрагмента запроса, в котором запрашиваются итоговые значения для сводного параметра browser.
"pivots": [
{
"fieldNames": [
"browser"
],
"limit": 10,
"metricAggregations": [
"TOTAL",
]
},
...
Вычисляемые показатели возвращаются в поле aggregates объекта RunPivotReportResponse. Для строк с агрегированными показателями поле dimensionValues содержит специальное значение RESERVED_TOTAL, RESERVED_MAX или RESERVED_MIN.
"aggregates": [
{
"dimensionValues": [
{
"value": "Chrome"
},
{
"value": "RESERVED_TOTAL"
},
{
"value": "RESERVED_TOTAL"
}
],
"metricValues": [
{
"value": "4"
}
]
},
{
"dimensionValues": [
{
"value": "Firefox"
},
{
"value": "RESERVED_TOTAL"
},
{
"value": "RESERVED_TOTAL"
}
],
"metricValues": [
{
"value": "6"
}
]
},
....
}
Разбивка на страницы
Как и в случае с методами Core Reporting, запросы сводки позволяют указывать поля limit и offset в объекте Pivot для реализации разбивки на страницы.
Настройки разбивки на страницы применяются к каждой сводке отдельно.
Поле limit является обязательным для каждого объекта Pivot, чтобы ограничить количество уникальных значений в отчете.
В Data API версии 1 поддерживается создание нескольких сводок, а результат параметра limit для каждой сводки не превышает 100 000.
В следующем фрагменте кода показано, как использовать поля offset и limit, чтобы получить следующие пять параметров language со смещением 10:
{
"fieldNames": [
"language"
],
"offset": 10,
"limit": 5
}
Фильтрация
Как и в случае с основными функциями отчетов, если вы хотите отфильтровать параметры в запросе сводного отчета, необходимо использовать фильтр параметров на уровне запроса.
Сортировка
Порядок сортировки в запросах сводных отчетов можно задавать для каждой сводки отдельно с помощью поля orderBys объекта Pivot, который содержит список объектов OrderBy.
Каждый элемент OrderBy может содержать один из следующих элементов:
- DimensionOrderBy сортирует результаты по значениям параметра.
- MetricOrderBy – сортировка результатов по значениям показателя.
- PivotOrderBy используется в сводных запросах и сортирует результаты по значениям показателя в группе сводных столбцов.
В этом примере показан фрагмент определения сводки, которая сводит отчет по параметру browser и упорядочивает результаты по показателю sessions в порядке убывания.
{
"fieldNames": [
"browser"
],
"limit": 5,
"orderBys": [
{
"metric": {
"metricName": "sessions"
},
"desc": true
}
]
}
Пожаловаться на ответ
Ответ на запрос сводного отчета в API состоит в основном из заголовка и строк.
Заголовки ответа
Заголовок сводного отчета состоит из PivotHeaders, DimensionHeaders и MetricHeaders, в которых перечислены столбцы сводного отчета.
Например, в отчете со сводными параметрами browser, country и language и показателем sessions будут следующие заголовки:
{
"pivotHeaders": [
{
"pivotDimensionHeaders": [
{
"dimensionValues": [
{
"value": "Chrome"
}
]
},
{
"dimensionValues": [
{
"value": "Firefox"
}
]
},
...
],
...
},
{
"pivotDimensionHeaders": [
{
"dimensionValues": [
{
"value": "United States"
}
]
},
{
"dimensionValues": [
{
"value": "Canada"
}
]
},
...
],
...
},
{
"pivotDimensionHeaders": [
{
"dimensionValues": [
{
"value": "English"
}
]
},
{
"dimensionValues": [
{
"value": "French"
}
]
},
...
],
...
}
],
"dimensionHeaders": [
{
"name": "browser"
},
{
"name": "country"
},
{
"name": "language"
}
],
"metricHeaders": [
{
"name": "sessions",
"type": "TYPE_INTEGER"
}
],
...
}
На следующей диаграмме показана роль каждого компонента Pivot Report Response в создании сводного отчета.

Строки в ответе
Ответ сводного отчета, полученный с помощью методов runPivotReport и batchRunPivotReports, отличается от ответа, полученного с помощью методов Core Reporting, таких как runReport и batchRunReports. Разница заключается в том, что каждая строка ответа сводного отчета представляет собой одну ячейку таблицы, тогда как в обычном отчете одна строка ответа представляет собой полную строку таблицы.
Ниже приведен фрагмент ответа на запрос сводного отчета с параметрами browser, country и language и показателем sessions. Каждая ячейка сводного отчета возвращается отдельно:
"rows": [
{
"dimensionValues": [
{
"value": "Chrome"
},
{
"value": "United States"
},
{
"value": "English"
}
],
"metricValues": [
{
"value": "1"
}
]
},
{
"dimensionValues": [
{
"value": "Firefox"
},
{
"value": "Canada"
},
{
"value": "French"
}
],
"metricValues": [
{
"value": "3"
}
]
},
...
]
Эти данные соответствуют двум ячейкам, выделенным в таблице ниже.

Клиентские библиотеки
Инструкции по установке и настройке клиентских библиотек приведены в кратком руководстве.
В примерах ниже показано, как с помощью клиентской библиотеки выполнить сводный запрос, чтобы создать отчет о количестве сеансов по странам со сводкой по параметру "Браузер".
PHP
use Google\Analytics\Data\V1beta\Client\BetaAnalyticsDataClient; use Google\Analytics\Data\V1beta\DateRange; use Google\Analytics\Data\V1beta\Dimension; use Google\Analytics\Data\V1beta\Metric; use Google\Analytics\Data\V1beta\OrderBy; use Google\Analytics\Data\V1beta\OrderBy\DimensionOrderBy; use Google\Analytics\Data\V1beta\OrderBy\MetricOrderBy; use Google\Analytics\Data\V1beta\Pivot; use Google\Analytics\Data\V1beta\RunPivotReportRequest; use Google\Analytics\Data\V1beta\RunPivotReportResponse; /** * Runs a pivot query to build a report of session counts by country, * pivoted by the browser dimension. * @param string $propertyId Your GA-4 Property ID */ function run_pivot_report(string $propertyId) { // Create an instance of the Google Analytics Data API client library. $client = new BetaAnalyticsDataClient(); // Make an API call. $request = (new RunPivotReportRequest()) ->setProperty('properties/' . $propertyId) ->setDateRanges([new DateRange([ 'start_date' => '2021-01-01', 'end_date' => '2021-01-30', ]), ]) ->setPivots([ new Pivot([ 'field_names' => ['country'], 'limit' => 250, 'order_bys' => [new OrderBy([ 'dimension' => new DimensionOrderBy([ 'dimension_name' => 'country', ]), ])], ]), new Pivot([ 'field_names' => ['browser'], 'offset' => 3, 'limit' => 3, 'order_bys' => [new OrderBy([ 'metric' => new MetricOrderBy([ 'metric_name' => 'sessions', ]), 'desc' => true, ])], ]), ]) ->setMetrics([new Metric(['name' => 'sessions'])]) ->setDimensions([ new Dimension(['name' => 'country']), new Dimension(['name' => 'browser']), ]); $response = $client->runPivotReport($request); printPivotReportResponse($response); } /** * Print results of a runPivotReport call. * @param RunPivotReportResponse $response */ function printPivotReportResponse(RunPivotReportResponse $response) { print 'Report result: ' . PHP_EOL; foreach ($response->getRows() as $row) { printf( '%s %s' . PHP_EOL, $row->getDimensionValues()[0]->getValue(), $row->getMetricValues()[0]->getValue() ); } }
Python
from google.analytics.data_v1beta import BetaAnalyticsDataClient from google.analytics.data_v1beta.types import ( DateRange, Dimension, Metric, OrderBy, Pivot, RunPivotReportRequest, ) def run_sample(): """Runs the sample.""" # TODO(developer): Replace this variable with your Google Analytics 4 # property ID before running the sample. property_id = "YOUR-GA4-PROPERTY-ID" run_pivot_report(property_id) def run_pivot_report(property_id="YOUR-GA4-PROPERTY-ID"): """Runs a pivot query to build a report of session counts by country, pivoted by the browser dimension.""" client = BetaAnalyticsDataClient() request = RunPivotReportRequest( property=f"properties/{property_id}", date_ranges=[DateRange(start_date="2021-01-01", end_date="2021-01-30")], pivots=[ Pivot( field_names=["country"], limit=250, order_bys=[ OrderBy( dimension=OrderBy.DimensionOrderBy(dimension_name="country") ) ], ), Pivot( field_names=["browser"], offset=3, limit=3, order_bys=[ OrderBy( metric=OrderBy.MetricOrderBy(metric_name="sessions"), desc=True ) ], ), ], metrics=[Metric(name="sessions")], dimensions=[Dimension(name="country"), Dimension(name="browser")], ) response = client.run_pivot_report(request) print_run_pivot_report_response(response) def print_run_pivot_report_response(response): """Prints results of a runPivotReport call.""" print("Report result:") for row in response.rows: for dimension_value in row.dimension_values: print(dimension_value.value) for metric_value in row.metric_values: print(metric_value.value)
Node.js
// TODO(developer): Uncomment this variable and replace with your // Google Analytics 4 property ID before running the sample. // propertyId = 'YOUR-GA4-PROPERTY-ID'; // Imports the Google Analytics Data API client library. const {BetaAnalyticsDataClient} = require('@google-analytics/data'); // Initialize client that will be used to send requests. This client only // needs to be created once, and can be reused for multiple requests. const analyticsDataClient = new BetaAnalyticsDataClient(); // Runs a pivot query to build a report of session counts by country, pivoted // by the browser dimension. async function runPivotReport() { const [response] = await analyticsDataClient.runPivotReport({ property: `properties/${propertyId}`, dateRanges: [ { startDate: '2021-01-01', endDate: '2021-01-30', }, ], pivots: [ { fieldNames: ['country'], limit: 250, orderBys: [ { dimension: { dimensionName: 'country', }, }, ], }, { fieldNames: ['browser'], offset: 3, limit: 3, orderBys: [ { metric: { metricName: 'sessions', }, desc: true, }, ], }, ], metrics: [ { name: 'sessions', }, ], dimensions: [ { name: 'country', }, { name: 'browser', }, ], }); printPivotReportResponse(response); } runPivotReport(); // Prints results of a runReport call. function printPivotReportResponse(response) { console.log('Report result:'); response.rows.forEach((row) => { row.dimensionValues.forEach((dimensionValue) => { console.log(dimensionValue.value); }); row.metricValues.forEach((metricValue) => { console.log(metricValue.value); }); }); }
Демонстрационное приложение
Пример создания и показа сводного отчета с помощью JavaScript можно найти в демо-приложении Google Аналитики API v1 Pivot Report.