- Ресурс: ReportTask
- ReportDefinition
- Параметр
- DimensionExpression
- CaseExpression
- ConcatenateExpression
- Показатель
- DateRange
- FilterExpression
- FilterExpressionList
- Фильтр
- StringFilter
- MatchType
- InListFilter
- NumericFilter
- Операция
- NumericValue
- BetweenFilter
- EmptyFilter
- MetricAggregation
- OrderBy
- MetricOrderBy
- DimensionOrderBy
- OrderType
- CohortSpec
- Когорта
- CohortsRange
- Детализация
- CohortReportSettings
- SamplingLevel
- ReportMetadata
- Состояние
- Методы
Ресурс: ReportTask
Определенная конфигурация задачи отчета.
| JSON-представление |
|---|
{ "name": string, "reportDefinition": { object ( |
| Поля | |
|---|---|
name |
Используется только для вывода. Идентификатор. Название ресурса задачи отчета, назначенное при создании. Формат: "properties/{property}/reportTasks/{reportTask}" |
reportDefinition |
Необязательное поле. Определение отчета для получения данных отчета, описывающее структуру отчета. Обычно в нем указываются поля, которые будут включены в отчет, и критерии, которые будут использоваться для фильтрации данных. |
reportMetadata |
Используется только для вывода. Метаданные отчета для определенной задачи, связанные с отчетом. Обычно в этом поле содержится следующая информация: название ресурса отчета, его статус, временная метка создания и т. д. |
ReportDefinition
Определение того, как должен выполняться отчет.
| JSON-представление |
|---|
{ "dimensions": [ { object ( |
| Поля | |
|---|---|
dimensions[] |
Необязательное поле. Запрошенные и отображаемые параметры. |
metrics[] |
Необязательное поле. Запрошенные и показанные показатели. |
dateRanges[] |
Необязательное поле. Диапазоны дат, для которых нужно получить данные. Если запрошено несколько диапазонов дат, каждая строка ответа будет содержать индекс диапазона дат, начинающийся с нуля. Если два диапазона дат пересекаются, данные о событиях за дни пересечения включаются в строки ответа для обоих диапазонов. В запросе когорты этот параметр |
dimensionFilter |
Необязательное поле. Фильтры параметров позволяют выбрать, какие значения параметров должны быть включены в отчет. Примеры можно найти в статье Основы фильтров параметров. В этом фильтре нельзя использовать показатели. |
metricFilter |
Необязательное поле. Условие фильтрации показателей. Применяется после агрегирования строк отчета, как и предложение HAVING в SQL. Параметры нельзя использовать в этом фильтре. |
offset |
Необязательное поле. Количество строк в начальной строке из хранилища Google Аналитики. Первая строка считается строкой 0. При создании задачи отчета параметры |
limit |
Необязательное поле. Количество строк, которые нужно вернуть в отчете. Если значение не указано, возвращается 10 000 строк. API возвращает не более 250 000 строк на запрос,независимо от того, сколько вы запросили. Значение параметра API также может возвращать меньше строк, чем указано в параметре |
metricAggregations[] |
Необязательное поле. Агрегирование показателей. Агрегированные значения показателей будут показываться в строках, где для параметра dimensionValues задано значение RESERVED_(MetricAggregation). |
orderBys[] |
Необязательное поле. Указывает, как упорядочиваются строки в ответе. |
currencyCode |
Необязательное поле. Код валюты в формате ISO 4217, например AED, USD или JPY. Если поле пустое, в отчете используется валюта по умолчанию для ресурса. |
cohortSpec |
Необязательное поле. Группа когорт, связанная с этим запросом. Если в запросе есть группа когорт, то должен присутствовать параметр "когорта". |
keepEmptyRows |
Необязательное поле. Если значение равно false или не указано, строки, в которых все показатели равны 0, не возвращаются. Если значение равно true, эти строки будут возвращены, если они не будут удалены фильтром. Независимо от этой настройки Например, если в свойстве никогда не регистрируется событие |
samplingLevel |
Необязательное поле. Уровень выборки отчета. |
Параметр
Параметры – это атрибуты данных. Например, параметр "Город" обозначает город, из которого поступило событие. Значения параметров в ответах на запросы отчетов – это строки, например "Париж" или "Нью-Йорк".
| JSON-представление |
|---|
{
"name": string,
"dimensionExpression": {
object ( |
| Поля | |
|---|---|
name |
Название параметра. Список названий параметров, поддерживаемых основными методами создания отчетов, такими как Если указан параметр Параметры упоминаются в |
dimensionExpression |
Один параметр может быть результатом выражения, включающего несколько параметров. Например, параметр "страна, город": concatenate(country, ", ", city). |
DimensionExpression
Используется для выражения размерности, которая является результатом формулы из нескольких размерностей. Примеры использования: 1) lowerCase(dimension); 2) concatenate(dimension1, symbol, dimension2).
| JSON-представление |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "lowerCase": { object ( |
| Поля | |
|---|---|
Укажите один тип выражения для параметра DimensionExpression. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: |
|
lowerCase |
Используется для преобразования значения параметра в нижний регистр. |
upperCase |
Используется для преобразования значения параметра в верхний регистр. |
concatenate |
Используется для объединения значений параметров в один параметр. Например, параметр "страна, город": concatenate(country, ", ", city). |
| Конец взаимоисключающих полей. | |
CaseExpression
Используется для преобразования значения параметра в один регистр.
| JSON-представление |
|---|
{ "dimensionName": string } |
| Поля | |
|---|---|
dimensionName |
Название параметра. Название должно совпадать с названием в поле параметров запроса. |
ConcatenateExpression
Используется для объединения значений параметров в один параметр.
| JSON-представление |
|---|
{ "dimensionNames": [ string ], "delimiter": string } |
| Поля | |
|---|---|
dimensionNames[] |
Названия параметров. Названия должны совпадать с названиями в поле параметров запроса. |
delimiter |
Разделитель, который используется между названиями параметров. Разделители часто представляют собой один символ, например "|" или ",", но могут быть и длиннее. Если значение параметра содержит разделитель, в ответе будут представлены оба значения без различий. Например, если значение параметра 1 – "US,FR", значение параметра 2 – "JP", а разделитель – ",", то в ответе будет "US,FR,JP". |
Показатель
Количественные показатели в отчете. Например, показатель eventCount – это общее количество событий. В запросе может быть до 10 показателей.
| JSON-представление |
|---|
{ "name": string, "expression": string, "invisible": boolean } |
| Поля | |
|---|---|
name |
Название показателя. Список названий показателей, поддерживаемых основными методами создания отчетов, такими как Если указан параметр Показатели упоминаются в |
expression |
Математическое выражение для вычисляемых показателей. Например, показатель "Событий на пользователя" – |
invisible |
Указывает, является ли показатель невидимым в ответе отчета. Если показатель невидим, в ответе не будет столбца с ним, но его можно использовать в |
DateRange
Непрерывный набор дней: startDate, startDate + 1, …, endDate. Можно запросить до четырех диапазонов дат.
| JSON-представление |
|---|
{ "startDate": string, "endDate": string, "name": string } |
| Поля | |
|---|---|
startDate |
Дата начала запроса (включительно) в формате |
endDate |
Дата окончания запроса (включительно) в формате |
name |
Название диапазона дат. Параметр |
FilterExpression
Для фильтрации параметров и показателей. Поля в одном выражении FilterExpression должны быть либо параметрами, либо показателями.
| JSON-представление |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "andGroup": { object ( |
| Поля | |
|---|---|
Для параметра FilterExpression можно указать только один тип выражения фильтра. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: |
|
andGroup |
Между выражениями FilterExpressions в группе andGroup действует логическое отношение И. |
orGroup |
Между выражениями фильтра в orGroup действует логическое отношение ИЛИ. |
notExpression |
FilterExpression не является notExpression. |
filter |
Простой фильтр. В одном выражении FilterExpression все названия полей фильтра должны быть либо параметрами, либо показателями. |
| Конец взаимоисключающих полей. | |
FilterExpressionList
Список выражений фильтра.
| JSON-представление |
|---|
{
"expressions": [
{
object ( |
| Поля | |
|---|---|
expressions[] |
Список выражений фильтра. |
Фильтр
Выражение для фильтрации значений параметров или показателей.
| JSON-представление |
|---|
{ "fieldName": string, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "stringFilter": { object ( |
| Поля | |
|---|---|
fieldName |
Название параметра или показателя. Должно быть названием, определенным в параметрах или показателях. |
Для Filter можно указать только один тип фильтра. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: |
|
stringFilter |
Фильтр по строкам. |
inListFilter |
Фильтр для значений в списке. |
numericFilter |
Фильтр для числовых значений или значений даты. |
betweenFilter |
Фильтр для значений в диапазоне. |
emptyFilter |
Фильтр для пустых значений, например |
| Конец взаимоисключающих полей. | |
StringFilter
Фильтр для строки
| JSON-представление |
|---|
{
"matchType": enum ( |
| Поля | |
|---|---|
matchType |
Тип соответствия для этого фильтра. |
value |
Строковое значение, используемое для сопоставления. |
caseSensitive |
Если значение равно true, в строке учитывается регистр. |
MatchType
Тип соответствия фильтра строк
| Перечисления | |
|---|---|
MATCH_TYPE_UNSPECIFIED |
Не указано |
EXACT |
Точное соответствие строкового значения. |
BEGINS_WITH |
Начинается со строкового значения. |
ENDS_WITH |
Заканчивается строковым значением. |
CONTAINS |
Содержит строковое значение. |
FULL_REGEXP |
Полное соответствие регулярного выражения строковому значению. |
PARTIAL_REGEXP |
Частичное совпадение регулярного выражения со строковым значением. |
InListFilter
Результат должен быть представлен в виде списка строковых значений.
| JSON-представление |
|---|
{ "values": [ string ], "caseSensitive": boolean } |
| Поля | |
|---|---|
values[] |
Список строковых значений. Не должно быть пустым. |
caseSensitive |
Если значение равно true, в строке учитывается регистр. |
NumericFilter
Фильтры для числовых значений или значений даты.
| JSON-представление |
|---|
{ "operation": enum ( |
| Поля | |
|---|---|
operation |
Тип операции для этого фильтра. |
value |
Числовое значение или значение даты. |
Операция
Операция, примененная к числовому фильтру.
| Перечисления | |
|---|---|
OPERATION_UNSPECIFIED |
Не указано. |
EQUAL |
Равно |
LESS_THAN |
Меньше чем |
LESS_THAN_OR_EQUAL |
Меньше или равно |
GREATER_THAN |
Больше чем |
GREATER_THAN_OR_EQUAL |
Больше или равно |
NumericValue
Для представления числа.
| JSON-представление |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "int64Value": string, "doubleValue": number // End of mutually exclusive fields. } |
| Поля | |
|---|---|
| Одно из числовых значений. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: | |
int64Value |
Целое число |
doubleValue |
Значение типа double |
| Конец взаимоисключающих полей. | |
BetweenFilter
Чтобы указать, что результат должен быть в диапазоне между двумя числами (включительно).
| JSON-представление |
|---|
{ "fromValue": { object ( |
| Поля | |
|---|---|
fromValue |
Начинается с этого числа. |
toValue |
Заканчивается на это число. |
EmptyFilter
У этого типа нет полей.
Отфильтруйте пустые значения. Соответствует значениям параметров "" или (not set). Используйте этот фильтр, чтобы найти строки с отсутствующими или незаполненными значениями параметров, или объедините его с notExpression, чтобы исключить такие строки из отчета, не фильтруя "" и (not set) по отдельности.
MetricAggregation
Представляет агрегированные показатели.
| Перечисления | |
|---|---|
METRIC_AGGREGATION_UNSPECIFIED |
Незаданный оператор. |
TOTAL |
оператор SUM. |
MINIMUM |
Минимальный оператор. |
MAXIMUM |
Максимальный оператор. |
COUNT |
Оператор Count. |
OrderBy
Параметры сортировки определяют, как будут отсортированы строки в ответе. Например, сортировка строк по убыванию количества событий – это один вариант, а сортировка строк по названию события – другой.
| JSON-представление |
|---|
{ "desc": boolean, // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "metric": { object ( |
| Поля | |
|---|---|
desc |
Если задано значение true, сортировка выполняется по убыванию. |
Укажите один тип сортировки для OrderBy. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей: |
|
metric |
Сортирует результаты по значениям показателя. |
dimension |
Сортирует результаты по значениям параметра. |
| Конец взаимоисключающих полей. | |
MetricOrderBy
Сортировка по значениям показателей.
| JSON-представление |
|---|
{ "metricName": string } |
| Поля | |
|---|---|
metricName |
Название показателя в запросе, по которому нужно выполнить сортировку. |
DimensionOrderBy
Сортировка по значениям параметров.
| JSON-представление |
|---|
{
"dimensionName": string,
"orderType": enum ( |
| Поля | |
|---|---|
dimensionName |
Название параметра в запросе, по которому нужно отсортировать данные. |
orderType |
Управляет правилом для упорядочивания значений параметров. |
OrderType
Правило, по которому сортируются значения строкового параметра.
| Перечисления | |
|---|---|
ORDER_TYPE_UNSPECIFIED |
Не указано. |
ALPHANUMERIC |
Сортировка по буквенно-цифровым символам в соответствии с кодовой точкой Unicode. Например, "2" < "A" < "X" < "b" < "z". |
CASE_INSENSITIVE_ALPHANUMERIC |
Сортировка по кодовой точке Unicode без учета регистра. Например, "2" < "A" < "b" < "X" < "z". |
NUMERIC |
Значения параметров преобразуются в числа перед сортировкой. Например, при сортировке по числовому значению "25" < "100", а при сортировке по значению ALPHANUMERIC "100" < "25". Нечисловые значения параметров имеют одинаковую ценность и располагаются ниже всех числовых значений. |
CohortSpec
Спецификация когорт для отчета о когорте.
В отчетах о когортах создаются временные ряды удержания пользователей для когорты. Например, можно выбрать когорту пользователей, привлеченных в первую неделю сентября, и отслеживать ее в течение следующих шести недель. Выбор когорты пользователей, привлеченных в первую неделю сентября, задается в объекте cohort. Отслеживание этой когорты в течение следующих шести недель задается в объекте cohortsRange.
Примеры приведены в разделе Примеры отчетов о когорте.
В ответе на запрос отчета может быть показан временной ряд с данными за неделю, например, что через три недели после установки приложением продолжали пользоваться 60% пользователей из когорты, а через шесть недель – 25 %. Оба этих процента можно рассчитать с помощью показателя cohortActiveUsers/cohortTotalUsers. В отчете они будут представлены в разных строках.
| JSON-представление |
|---|
{ "cohorts": [ { object ( |
| Поля | |
|---|---|
cohorts[] |
Определяет критерии выбора для группировки пользователей в когорты. В большинстве отчетов о когортах определяется только одна когорта. Если указано несколько когорт, каждая из них будет распознаваться в отчете по названию. |
cohortsRange |
Отчеты о когортах позволяют отслеживать когорты в течение длительного периода времени. Этот диапазон определяет смещение, которое будет использоваться для отслеживания когорт. |
cohortReportSettings |
Необязательные настройки для отчета о когорте. |
Когорта
Определяет критерии выбора когорты. Когорта – это группа пользователей с общим свойством. Например, пользователи с одинаковым значением firstSessionDate относятся к одной когорте.
| JSON-представление |
|---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
| Поля | |
|---|---|
name |
Назначает название этой когорте. Параметр |
dimension |
Параметр, используемый когортой. Обязательный параметр, поддерживающий только значение |
dateRange |
Когорта выбирает пользователей, чья дата первого взаимодействия находится в диапазоне между датой начала и датой окончания, определенными в В запросе когорты этот параметр Значение |
CohortsRange
Настраивает расширенный диапазон дат для отчета о когортах. Указывает продолжительность смещения, в течение которого нужно отслеживать когорты.
| JSON-представление |
|---|
{
"granularity": enum ( |
| Поля | |
|---|---|
granularity |
Обязательно. Уровень детализации, используемый для интерпретации значений |
startOffset |
Если Если Если |
endOffset |
Обязательно. Если Если Если |
Уровень детализации
Уровень детализации, используемый для интерпретации значений startOffset и endOffset для расширенного диапазона дат в отчете о когорте.
| Перечисления | |
|---|---|
GRANULARITY_UNSPECIFIED |
Указывать его не нужно. |
DAILY |
Уровень детализации – "День". Обычно используется, если dateRange когорты – один день, а запрос содержит cohortNthDay. |
WEEKLY |
Детализация по неделям. Обычно используется, если продолжительность когорты dateRange составляет неделю (с воскресенья по субботу), а запрос содержит cohortNthWeek. |
MONTHLY |
Ежемесячная детализация. Обычно используется, если продолжительность когорты dateRange составляет месяц, а запрос содержит cohortNthMonth. |
CohortReportSettings
Необязательные настройки когортного отчета.
| JSON-представление |
|---|
{ "accumulate": boolean } |
| Поля | |
|---|---|
accumulate |
Если значение равно true, результаты накапливаются с первого дня взаимодействия до последнего дня. Не поддерживается в |
SamplingLevel
Категории уровней выборки для запросов.
| Перечисления | |
|---|---|
SAMPLING_LEVEL_UNSPECIFIED |
Неуказанный тип. |
LOW |
Применяет уровень выборки 10 миллионов для стандартных ресурсов и 100 миллионов для ресурсов Google Аналитики 360. |
MEDIUM |
Доступно только для ресурсов Google Аналитики 360 с уровнем выборки 1 млрд. |
UNSAMPLED |
Доступно только в ресурсах Google Аналитики 360. Исследования с полными данными более точны и могут выявить статистику, недоступную в стандартных исследованиях. Подробнее: https://support.google.com/analytics/answer/10896953. |
ReportMetadata
Метаданные отчета для определенной задачи отчета.
| JSON-представление |
|---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
| Поля | |
|---|---|
creationQuotaTokensCharged |
Используется только для вывода. Общее количество токенов квоты, списанных при создании отчета. Поскольку количество токенов рассчитывается на основе действий в состоянии |
state |
Используется только для вывода. Текущий статус задачи для отчета. |
beginCreatingTime |
Используется только для вывода. Время, когда был вызван метод Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: |
taskRowCount |
Используется только для вывода. Общее количество строк в результатах отчета. Это поле заполняется, когда статус активен. Вы можете использовать |
errorMessage |
Используется только для вывода. Сообщение об ошибке, если при создании отчета произошла ошибка. |
totalRowCount |
Используется только для вывода. Общее количество строк в хранилище Google Аналитики. Если вы хотите запросить дополнительные строки данных, помимо тех, что есть в текущем отчете, вы можете запустить новую задачу создания отчета на основе
Например, если в текущем отчете значение параметра |
Штат
Статус обработки.
| Перечисления | |
|---|---|
STATE_UNSPECIFIED |
Состояние "Не указано" никогда не используется. |
CREATING |
Отчет создается и будет доступен позже. Создание отчета начинается сразу после вызова CreateReport. |
ACTIVE |
Отчет создан и готов к запросам. |
FAILED |
Не удалось создать отчет. |
Методы |
|
|---|---|
|
Запускает создание задачи отчета. |
|
Получает метаданные отчета о конкретной задаче создания отчета. |
|
Выводит список всех задач по созданию отчетов для ресурса. |
|
Получает контент задачи создания отчета. |