- Ресурс: ReportTask
- Определение отчета
- Измерение
- Выражение Измерения
- Выражение случая
- ОбъединитьВыражение
- Метрика
- Диапазон дат
- Выражение фильтра
- Список выражений фильтра
- Фильтр
- Строковый фильтр
- Тип соответствия
- Инлистфильтр
- ЧисловойФильтр
- Операция
- Числовое значение
- МеждуФильтр
- Агрегация метрик
- Заказ по
- MetricOrderBy
- DimensionOrderBy
- Тип заказа
- Спецификация когорты
- когорта
- КогортыДиапазон
- Детализация
- Настройки отчета когорты
- Уровень выборки
- Метаданные отчета
- Состояние
- Методы
Ресурс: ReportTask
Конкретная конфигурация задачи отчета.
JSON-представление |
---|
{ "name": string, "reportDefinition": { object ( |
Поля | |
---|---|
name | Только вывод. Идентификатор. Имя ресурса задачи отчета, назначенное при создании. Формат: «свойства/{свойство}/reportTasks/{reportTask}» |
report Definition | Необязательный. Определение отчета для получения данных отчета, описывающих структуру отчета. Обычно он включает поля, которые будут включены в отчет, и критерии, которые будут использоваться для фильтрации данных. |
report Metadata | Только вывод. Метаданные отчета для конкретной задачи отчета, которые предоставляют информацию об отчете. Обычно он включает следующую информацию: имя ресурса отчета, состояние отчета, временную метку создания отчета и т. д. |
Определение отчета
Определение того, как следует запускать отчет.
JSON-представление |
---|
{ "dimensions": [ { object ( |
Поля | |
---|---|
dimensions[] | Необязательный. Запрошенные и отображенные размеры. |
metrics[] | Необязательный. Запрошенные и отображаемые метрики. |
date Ranges[] | Необязательный. Диапазоны дат данных для чтения. Если запрошено несколько диапазонов дат, каждая строка ответа будет содержать индекс диапазона дат, отсчитываемый от нуля. Если два диапазона дат перекрываются, данные о событиях для перекрывающихся дней включаются в строки ответов для обоих диапазонов дат. В запросе когорты этот |
dimension Filter | Необязательный. Фильтры измерений позволяют запрашивать в отчете только определенные значения измерений. Дополнительные сведения см. в разделе «Основы фильтров измерений» . В этом фильтре нельзя использовать метрики. |
metric Filter | Необязательный. Предложение фильтра метрик. Применяется после агрегирования строк отчета, аналогично предложению «have» в SQL. В этом фильтре нельзя использовать размеры. |
offset | Необязательный. Количество строк в начальной строке из хранилища Google Analytics. Первая строка считается строкой 0. При создании задачи отчета параметры |
limit | Необязательный. Количество строк, возвращаемых в отчете. Если не указано, возвращается 10 000 строк. API возвращает максимум 250 000 строк на запрос, независимо от того, сколько вы запрашиваете. API также может возвращать меньше строк, чем запрошенное |
metric Aggregations[] | Необязательный. Агрегация метрик. Агрегированные значения показателей будут отображаться в строках, где для параметра DimensionValues установлено значение «RESERVED_(MetricAggregation)». |
order Bys[] | Необязательный. Указывает, как упорядочены строки в ответе. |
currency Code | Необязательный. Код валюты в формате ISO4217, например «AED», «USD», «JPY». Если поле пусто, в отчете используется валюта ресурса по умолчанию. |
cohort Spec | Необязательный. Когортная группа, связанная с этим запросом. Если в запросе есть когортная группа, параметр «когорта» должен присутствовать. |
keep Empty Rows | Необязательный. Если значение false или не указано, каждая строка со всеми метриками, равными 0, не будет возвращена. Если это правда, эти строки будут возвращены, если они не будут удалены фильтром отдельно. Независимо от этого параметра Например, если свойство никогда не регистрирует событие |
sampling Level | Необязательный. Уровень выборки отчета. |
Измерение
Измерения — это атрибуты ваших данных. Например, параметр «Город» указывает город, из которого происходит событие. Значения измерений в ответах отчета представляют собой строки; например, городом может быть «Париж» или «Нью-Йорк».
JSON-представление |
---|
{
"name": string,
"dimensionExpression": {
object ( |
Поля | |
---|---|
name | Имя измерения. См. раздел «Измерения API» для получения списка имен измерений, поддерживаемых основными методами отчетности, такими как Если На измерения ссылаются по |
dimension Expression | Одно измерение может быть результатом выражения нескольких измерений. Например, измерение «страна, город»: concatenate(country, «, «, city). |
Выражение Измерения
Используется для выражения измерения, которое является результатом формулы нескольких измерений. Примеры использования: 1) нижний регистр (размерность) 2) объединение (размерность1, символ, размерность2).
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения one_expression . Укажите один тип выражения измерения для DimensionExpression . one_expression может быть только одним из следующих: | |
lower Case | Используется для преобразования значения размера в нижний регистр. |
upper Case | Используется для преобразования значения размера в верхний регистр. |
concatenate | Используется для объединения значений измерения в одно измерение. Например, измерение «страна, город»: concatenate(country, «, «, city). |
Выражение случая
Используется для преобразования значения измерения в один случай.
JSON-представление |
---|
{ "dimensionName": string } |
Поля | |
---|---|
dimension Name | Имя измерения. Имя должно ссылаться на имя в поле размеров запроса. |
ОбъединитьВыражение
Используется для объединения значений измерения в одно измерение.
JSON-представление |
---|
{ "dimensionNames": [ string ], "delimiter": string } |
Поля | |
---|---|
dimension Names[] | Названия размеров. Имена должны ссылаться на имена в поле измерений запроса. |
delimiter | Разделитель, помещаемый между именами измерений. Разделителями часто являются одиночные символы, такие как «|». или «,», но могут быть и более длинными строками. Если значение измерения содержит разделитель, в ответе будут присутствовать оба без различия. Например, если значение параметра 1 = «US,FR», значение параметра 2 = «JP» и разделитель = «,», то ответ будет содержать «US,FR,JP». |
Метрика
Количественные измерения отчета. Например, метрика eventCount
— это общее количество событий. Запросы разрешены до 10 метрик.
JSON-представление |
---|
{ "name": string, "expression": string, "invisible": boolean } |
Поля | |
---|---|
name | Имя метрики. См. раздел «Метрики API» для получения списка имен метрик, поддерживаемых основными методами отчетности, такими как Если указано На метрики ссылаются по |
expression | Математическое выражение для производных показателей. Например, метрика «Количество событий на пользователя» — |
invisible | Указывает, невидима ли метрика в ответе отчета. Если метрика невидима, она не будет создавать столбец в ответе, но ее можно использовать в |
Диапазон дат
Непрерывный набор дней: startDate
, startDate + 1
, ..., endDate
. Запросы разрешены до 4 диапазонов дат.
JSON-представление |
---|
{ "startDate": string, "endDate": string, "name": string } |
Поля | |
---|---|
start Date | Включающая дата начала запроса в формате |
end Date | Включающая дата окончания запроса в формате |
name | Присваивает имя этому диапазону дат. Измерение |
Выражение фильтра
Для выражения фильтров параметров или показателей. Поля в одном выражении фильтра должны содержать либо все измерения, либо все показатели.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Союз полевых expr . Укажите один тип выражения фильтра для FilterExpression . expr может быть только одним из следующих: | |
and Group | Выражения FilterExpressions в andGroup имеют отношение AND. |
or Group | Выражения FilterExpressions в orGroup имеют отношение ИЛИ. |
not Expression | FilterExpression НЕ является выражением notExpression. |
filter | Примитивный фильтр. В одном и том же выражении FilterExpression все имена полей фильтра должны быть либо всеми измерениями, либо всеми метриками. |
Список выражений фильтра
Список выражений фильтра.
JSON-представление |
---|
{
"expressions": [
{
object ( |
Поля | |
---|---|
expressions[] | Список выражений фильтра. |
Фильтр
Выражение для фильтрации значений параметра или показателя.
JSON-представление |
---|
{ "fieldName": string, // Union field |
Поля | |
---|---|
field Name | Имя измерения или имя метрики. Должно быть имя, определенное в параметрах или показателях. |
Поле объединения one_filter . Укажите один тип фильтра для Filter . one_filter может быть только одним из следующих: | |
string Filter | Фильтр, связанный со строками. |
in List Filter | Фильтр для значений в списке. |
numeric Filter | Фильтр для числовых значений или значений даты. |
between Filter | Фильтр между двумя значениями. |
Строковый фильтр
Фильтр для строки
JSON-представление |
---|
{
"matchType": enum ( |
Поля | |
---|---|
match Type | Тип соответствия для этого фильтра. |
value | Строковое значение, используемое для сопоставления. |
case Sensitive | Если это правда, строковое значение чувствительно к регистру. |
Тип соответствия
Тип соответствия строкового фильтра
Перечисления | |
---|---|
MATCH_TYPE_UNSPECIFIED | Не указано |
EXACT | Точное совпадение строкового значения. |
BEGINS_WITH | Начинается со строкового значения. |
ENDS_WITH | Заканчивается строковым значением. |
CONTAINS | Содержит строковое значение. |
FULL_REGEXP | Полное совпадение регулярного выражения со строковым значением. |
PARTIAL_REGEXP | Частичное совпадение регулярного выражения со строковым значением. |
Инлистфильтр
Результат должен быть в списке строковых значений.
JSON-представление |
---|
{ "values": [ string ], "caseSensitive": boolean } |
Поля | |
---|---|
values[] | Список строковых значений. Должно быть непусто. |
case Sensitive | Если это правда, строковое значение чувствительно к регистру. |
ЧисловойФильтр
Фильтры для числовых значений или значений даты.
JSON-представление |
---|
{ "operation": enum ( |
Поля | |
---|---|
operation | Тип операции для этого фильтра. |
value | Числовое значение или значение даты. |
Операция
Операция, примененная к числовому фильтру
Перечисления | |
---|---|
OPERATION_UNSPECIFIED | Не указано. |
EQUAL | Равный |
LESS_THAN | Меньше, чем |
LESS_THAN_OR_EQUAL | Меньше или равно |
GREATER_THAN | Больше, чем |
GREATER_THAN_OR_EQUAL | Больше или равно |
Числовое значение
Чтобы представить число.
JSON-представление |
---|
{ // Union field |
Поля | |
---|---|
Поле объединения one_value . Одно из числовых значений one_value может быть только одним из следующих: | |
int64 Value | Целое значение |
double Value | Двойное значение |
МеждуФильтр
Чтобы выразить это, результат должен находиться между двумя числами (включительно).
JSON-представление |
---|
{ "fromValue": { object ( |
Поля | |
---|---|
from Value | Начинается с этого номера. |
to Value | Заканчивается этим номером. |
Агрегация метрик
Представляет агрегирование метрик.
Перечисления | |
---|---|
METRIC_AGGREGATION_UNSPECIFIED | Неопределенный оператор. |
TOTAL | Оператор СУММ. |
MINIMUM | Минимальный оператор. |
MAXIMUM | Максимальный оператор. |
COUNT | Оператор счета. |
Заказ по
Order bys определяет, как будут сортироваться строки в ответе. Например, упорядочивание строк по убыванию количества событий — это один порядок, а упорядочивание строк по строке имени события — другой порядок.
JSON-представление |
---|
{ "desc": boolean, // Union field |
Поля | |
---|---|
desc | Если true, сортируется по убыванию. |
Поле объединения one_order_by . Укажите один тип заказа для OrderBy . one_order_by может быть только одним из следующих: | |
metric | Сортирует результаты по значениям показателей. |
dimension | Сортирует результаты по значениям измерения. |
MetricOrderBy
Сортировка по значениям показателей.
JSON-представление |
---|
{ "metricName": string } |
Поля | |
---|---|
metric Name | Имя метрики в запросе для упорядочения. |
DimensionOrderBy
Сортировка по значениям измерений.
JSON-представление |
---|
{
"dimensionName": string,
"orderType": enum ( |
Поля | |
---|---|
dimension Name | Имя измерения в запросе на упорядочивание. |
order Type | Управляет правилом упорядочения значений измерения. |
Тип заказа
Правило для упорядочивания значений размеров строки.
Перечисления | |
---|---|
ORDER_TYPE_UNSPECIFIED | Не указано. |
ALPHANUMERIC | Буквенно-цифровая сортировка по кодовой точке Юникода. Например, «2» < «A» < «X» < «b» < «z». |
CASE_INSENSITIVE_ALPHANUMERIC | Буквенно-цифровая сортировка без учета регистра по строчным буквам кода Юникода. Например, «2» < «A» < «b» < «X» < «z». |
NUMERIC | Перед сортировкой значения измерений преобразуются в числа. Например, при ЦИФРОВОЙ сортировке «25» < «100» и при ALPHANUMERIC сортировке «100» < «25». Все нечисловые значения размеров имеют одинаковое значение порядка ниже всех числовых значений. |
Спецификация когорты
Спецификация когорт для отчета о когортах.
Отчеты по когортам создают временные ряды удержания пользователей для когорты. Например, вы можете выбрать группу пользователей, привлеченных в первую неделю сентября, и следить за этой группой в течение следующих шести недель. Выбор когорты пользователей, привлеченных в первую неделю сентября, указан в объекте cohort
. Следующая когорта на следующие шесть недель указана в объекте cohortsRange
.
Примеры см. в разделе «Примеры когортных отчетов» .
Ответ на отчет может содержать еженедельный временной ряд, в котором, скажем, ваше приложение удержало 60 % этой группы через три недели и 25 % этой группы через шесть недель. Эти два процента могут быть рассчитаны по метрике cohortActiveUsers/cohortTotalUsers
и будут представлять собой отдельные строки в отчете.
JSON-представление |
---|
{ "cohorts": [ { object ( |
Поля | |
---|---|
cohorts[] | Определяет критерии отбора для группировки пользователей в когорты. В большинстве отчетов о когортах определяется только одна когорта. Если указано несколько когорт, каждая когорта может быть распознана в отчете по названию. |
cohorts Range | Отчеты по когортам следуют за когортами за расширенный диапазон дат отчетности. Этот диапазон определяет продолжительность смещения для отслеживания когорт. |
cohort Report Settings | Дополнительные настройки для когортного отчета. |
когорта
Определяет критерии отбора когорты. Когорта — это группа пользователей, имеющих общие характеристики. Например, пользователи с одинаковым значением firstSessionDate
принадлежат к одной когорте.
JSON-представление |
---|
{
"name": string,
"dimension": string,
"dateRange": {
object ( |
Поля | |
---|---|
name | Присваивает имя этой когорте. |
dimension | Измерение, используемое когортой. Требуется и поддерживает только |
date Range | Когорта выбирает пользователей, дата первого контакта которых находится между датой начала и датой окончания, определенной в В запросе когорты этот Этот |
КогортыДиапазон
Настраивает расширенный диапазон дат отчета для когортного отчета. Указывает продолжительность смещения для отслеживания когорт.
JSON-представление |
---|
{
"granularity": enum ( |
Поля | |
---|---|
granularity | Необходимый. Степень детализации, используемая для интерпретации значений |
start Offset | Если Если Если |
end Offset | Необходимый. Если Если Если |
Детализация
Степень детализации, используемая для интерпретации значений startOffset
и endOffset
для расширенного диапазона дат отчетности для когортного отчета.
Перечисления | |
---|---|
GRANULARITY_UNSPECIFIED | Никогда не следует указывать. |
DAILY | Ежедневная детализация. Обычно используется, если dateRange когорты представляет собой один день и запрос содержит cohortNthDay . |
WEEKLY | Еженедельная детализация. Обычно используется, если dateRange когорты длится неделю (начиная с воскресенья и заканчивая субботой), а запрос содержит cohortNthWeek . |
MONTHLY | Месячная детализация. Обычно используется, если dateRange когорты имеет продолжительность месяц и запрос содержит cohortNthMonth . |
Настройки отчета когорты
Дополнительные настройки когортного отчета.
JSON-представление |
---|
{ "accumulate": boolean } |
Поля | |
---|---|
accumulate | Если это правда, накапливается результат от первого дня касания до конечного дня. Не поддерживается в |
Уровень выборки
Категории уровней выборки для запросов.
Перечисления | |
---|---|
SAMPLING_LEVEL_UNSPECIFIED | Неопределенный тип. |
LOW | Применяет уровень выборки 10 миллионов к стандартным ресурсам и 100 миллионов к ресурсам Google Analytics 360. |
MEDIUM | Эксклюзивно для ресурсов Google Analytics 360 с уровнем выборки 1 миллиард. |
UNSAMPLED | Эксклюзивно для ресурсов Google Analytics 360. Исследования без выборки более точны и могут выявить информацию, недоступную в стандартных исследованиях. Дополнительную информацию см. на странице https://support.google.com/analytics/answer/10896953 . |
Метаданные отчета
Метаданные отчета для конкретной задачи отчета.
JSON-представление |
---|
{
"creationQuotaTokensCharged": integer,
"state": enum ( |
Поля | |
---|---|
creation Quota Tokens Charged | Только вывод. Общая сумма токенов квоты, начисленная при создании отчета. Поскольку это количество токенов основано на активности из состояния |
state | Только вывод. Текущее состояние этой задачи отчета. |
begin Creating Time | Только вывод. Время, когда был вызван Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
task Row Count | Только вывод. Общее количество строк в результате отчета. Это поле будет заполнено, когда состояние активно. Вы можете использовать |
error Message | Только вывод. Сообщение об ошибке отображается, если задача отчета завершается сбоем во время создания. |
total Row Count | Только вывод. Общее количество строк в хранилище Google Analytics. Если вы хотите запросить дополнительные строки данных помимо текущего отчета, они могут инициировать новую задачу отчета на основе Например, предположим, что |
Состояние
Состояние обработки.
Перечисления | |
---|---|
STATE_UNSPECIFIED | Неопределенное состояние никогда не будет использоваться. |
CREATING | Отчет в настоящее время создается и будет доступен в будущем. Создание происходит сразу после вызова CreateReport. |
ACTIVE | Отчет полностью создан и готов к запросам. |
FAILED | Не удалось создать отчет. |
Методы | |
---|---|
| Инициирует создание задачи отчета. |
| Получает метаданные отчета о конкретной задаче отчета. |
| Перечисляет все задачи отчета для свойства. |
| Получает содержимое задачи отчета. |