REST Resource: properties.reportTasks

Ресурс: ReportTask

Конкретная конфигурация задачи отчета.

JSON-представление 
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
Поля
name

string

Только вывод. Идентификатор. Имя ресурса задачи отчета, назначенное при создании. Формат: «свойства/{свойство}/reportTasks/{reportTask}»

report Definition

object ( ReportDefinition )

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

report Metadata

object ( ReportMetadata )

Только вывод. Метаданные отчета для конкретной задачи отчета, которые предоставляют информацию об отчете. Обычно он включает следующую информацию: имя ресурса отчета, состояние отчета, временную метку создания отчета и т. д.

Определение отчета

Определение того, как следует запускать отчет.

JSON-представление 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "samplingLevel": enum (SamplingLevel)
}
Поля
dimensions[]

object ( Dimension )

Необязательный. Запрошенные и отображенные размеры.

metrics[]

object ( Metric )

Необязательный. Запрошенные и отображаемые метрики.

date Ranges[]

object ( DateRange )

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

dimension Filter

object ( FilterExpression )

Необязательный. Фильтры измерений позволяют запрашивать в отчете только определенные значения измерений. Дополнительные сведения см. в разделе «Основы фильтров измерений» . В этом фильтре нельзя использовать метрики.

metric Filter

object ( FilterExpression )

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

offset

string ( int64 format)

Необязательный. Количество строк в начальной строке из хранилища Google Analytics. Первая строка считается строкой 0.

При создании задачи отчета параметры offset и limit определяют подмножество строк данных из хранилища Google Analytics, которые будут включены в созданный отчет. Например, если в хранилище Google Analytics всего 300 000 строк, первоначальная задача отчета может содержать первые 10 000 строк с ограничением в 10 000 и смещением 0. Впоследствии другая задача отчета может охватывать следующие 10 000 строк с помощью лимит 10 000 и смещение 10 000.

limit

string ( int64 format)

Необязательный. Количество строк, возвращаемых в отчете. Если не указано, возвращается 10 000 строк. API возвращает максимум 250 000 строк на запрос, независимо от того, сколько вы запрашиваете. limit должен быть положительным.

API также может возвращать меньше строк, чем запрошенное limit , если значений измерения не так много, как limit . Например, для параметра country существует менее 300 возможных значений, поэтому при составлении отчета только по country вы не сможете получить более 300 строк, даже если вы установите limit на более высокое значение.

metric Aggregations[]

enum ( MetricAggregation )

Необязательный. Агрегация метрик. Агрегированные значения показателей будут отображаться в строках, где для параметра DimensionValues ​​установлено значение «RESERVED_(MetricAggregation)».

order Bys[]

object ( OrderBy )

Необязательный. Указывает, как упорядочены строки в ответе.

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.

sampling Level

enum ( SamplingLevel )

Необязательный. Уровень выборки отчета.

Измерение

Измерения — это атрибуты ваших данных. Например, параметр «Город» указывает город, из которого происходит событие. Значения измерений в ответах отчета представляют собой строки; например, городом может быть «Париж» или «Нью-Йорк».

JSON-представление 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
Поля
name

string

Имя измерения. См. раздел «Измерения API» для получения списка имен измерений, поддерживаемых основными методами отчетности, такими как runReport batchRunReports . См . раздел «Измерения реального времени» для получения списка имен измерений, поддерживаемых методом runRealtimeReport . См. раздел «Измерения последовательности» для получения списка имен измерений, поддерживаемых методом runFunnelReport .

Если dimensionExpression указан, name может быть любой строкой в ​​разрешенном наборе символов. Например, если dimensionExpression объединяет country и city , вы можете назвать это измерение countryAndCity . Выбранные вами имена измерений должны соответствовать регулярному выражению ^[a-zA-Z0-9_]$ .

На измерения ссылаются по name в dimensionFilter , orderBys , dimensionExpression и pivots .

dimension Expression

object ( DimensionExpression )

Одно измерение может быть результатом выражения нескольких измерений. Например, измерение «страна, город»: concatenate(country, «, «, city).

Выражение Измерения

Используется для выражения измерения, которое является результатом формулы нескольких измерений. Примеры использования: 1) нижний регистр (размерность) 2) объединение (размерность1, символ, размерность2).

JSON-представление 
{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}
Поля
Поле объединения one_expression . Укажите один тип выражения измерения для DimensionExpression . one_expression может быть только одним из следующих:
lower Case

object ( CaseExpression )

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

upper Case

object ( CaseExpression )

Используется для преобразования значения размера в верхний регистр.

concatenate

object ( ConcatenateExpression )

Используется для объединения значений измерения в одно измерение. Например, измерение «страна, город»: concatenate(country, «, «, city).

Выражение случая

Используется для преобразования значения измерения в один случай.

JSON-представление 
{
  "dimensionName": string
}
Поля
dimension Name

string

Имя измерения. Имя должно ссылаться на имя в поле размеров запроса.

ОбъединитьВыражение

Используется для объединения значений измерения в одно измерение.

JSON-представление 
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Поля
dimension Names[]

string

Названия размеров. Имена должны ссылаться на имена в поле измерений запроса.

delimiter

string

Разделитель, помещаемый между именами измерений.

Разделителями часто являются одиночные символы, такие как «|». или «,», но могут быть и более длинными строками. Если значение измерения содержит разделитель, в ответе будут присутствовать оба без различия. Например, если значение параметра 1 = «US,FR», значение параметра 2 = «JP» и разделитель = «,», то ответ будет содержать «US,FR,JP».

Метрика

Количественные измерения отчета. Например, метрика eventCount — это общее количество событий. Запросы разрешены до 10 метрик.

JSON-представление 
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Поля
name

string

Имя метрики. См. раздел «Метрики API» для получения списка имен метрик, поддерживаемых основными методами отчетности, такими как runReport batchRunReports . См . раздел «Метрики реального времени» , где приведен список имен метрик, поддерживаемых методом runRealtimeReport . См. раздел «Метрики последовательности» для получения списка имен метрик, поддерживаемых методом runFunnelReport .

Если указано expression , name может быть любая строка в разрешенном наборе символов. Например, если expression — screenPageViews/sessions , вы можете назвать эту метрику именем = viewsPerSession . Имена метрик, которые вы выбираете, должны соответствовать регулярному выражению ^[a-zA-Z0-9_]$ .

На метрики ссылаются по name в metricFilter , orderBys и expression метрики.

expression

string

Математическое выражение для производных показателей. Например, метрика «Количество событий на пользователя» — eventCount/totalUsers .

invisible

boolean

Указывает, невидима ли метрика в ответе отчета. Если метрика невидима, она не будет создавать столбец в ответе, но ее можно использовать в metricFilter , orderBys или expression метрики.

Диапазон дат

Непрерывный набор дней: startDate , startDate + 1 , ..., endDate . Запросы разрешены до 4 диапазонов дат.

JSON-представление 
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Поля
start Date

string

Включающая дата начала запроса в формате YYYY-MM-DD . Не может быть после endDate . Формат NdaysAgo , yesterday или today также принимается, и в этом случае дата определяется на основе часового пояса, в котором указан ресурс.

end Date

string

Включающая дата окончания запроса в формате YYYY-MM-DD . Не может быть раньше startDate . Формат NdaysAgo , yesterday или today также принимается, и в этом случае дата определяется на основе часового пояса, в котором указан ресурс.

name

string

Присваивает имя этому диапазону дат. Измерение dateRange оценивается по этому имени в ответе отчета. Если установлено, не может начинаться с date_range_ или RESERVED_ . Если этот параметр не установлен, диапазоны дат именуются по индексу, начинающемуся с нуля, в запросе: date_range_0 , date_range_1 и т. д.

Выражение фильтра

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

JSON-представление 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип выражения фильтра для FilterExpression . expr может быть только одним из следующих:
and Group

object ( FilterExpressionList )

Выражения FilterExpressions в andGroup имеют отношение AND.

or Group

object ( FilterExpressionList )

Выражения FilterExpressions в orGroup имеют отношение ИЛИ.

not Expression

object ( FilterExpression )

FilterExpression НЕ является выражением notExpression.

filter

object ( Filter )

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

Список выражений фильтра

Список выражений фильтра.

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

object ( FilterExpression )

Список выражений фильтра.

Фильтр

Выражение для фильтрации значений параметра или показателя.

JSON-представление 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of list of possible types for union field one_filter.
}
Поля
field Name

string

Имя измерения или имя метрики. Должно быть имя, определенное в параметрах или показателях.

Поле объединения one_filter . Укажите один тип фильтра для Filter . one_filter может быть только одним из следующих:
string Filter

object ( StringFilter )

Фильтр, связанный со строками.

in List Filter

object ( InListFilter )

Фильтр для значений в списке.

numeric Filter

object ( NumericFilter )

Фильтр для числовых значений или значений даты.

between Filter

object ( BetweenFilter )

Фильтр между двумя значениями.

empty Filter

object ( EmptyFilter )

Фильтр для пустых значений, таких как значения «(не установлено)» и «».

Строковый фильтр

Фильтр для строки

JSON-представление 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Поля
match Type

enum ( MatchType )

Тип соответствия для этого фильтра.

value

string

Строковое значение, используемое для сопоставления.

case Sensitive

boolean

Если это правда, строковое значение чувствительно к регистру.

Тип соответствия

Тип соответствия строкового фильтра

Перечисления
MATCH_TYPE_UNSPECIFIED Не указано
EXACT Точное совпадение строкового значения.
BEGINS_WITH Начинается со строкового значения.
ENDS_WITH Заканчивается строковым значением.
CONTAINS Содержит строковое значение.
FULL_REGEXP Полное совпадение регулярного выражения со строковым значением.
PARTIAL_REGEXP Частичное совпадение регулярного выражения со строковым значением.

Инлистфильтр

Результат должен быть в списке строковых значений.

JSON-представление 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Поля
values[]

string

Список строковых значений. Должно быть непусто.

case Sensitive

boolean

Если это правда, строковое значение чувствительно к регистру.

ЧисловойФильтр

Фильтры для числовых значений или значений даты.

JSON-представление 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Поля
operation

enum ( Operation )

Тип операции для этого фильтра.

value

object ( NumericValue )

Числовое значение или значение даты.

Операция

Операция, примененная к числовому фильтру

Перечисления
OPERATION_UNSPECIFIED Не указано.
EQUAL Равный
LESS_THAN Меньше, чем
LESS_THAN_OR_EQUAL Меньше или равно
GREATER_THAN Больше, чем
GREATER_THAN_OR_EQUAL Больше или равно

Числовое значение

Чтобы представить число.

JSON-представление 
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
Поля
Поле объединения one_value . Одно из числовых значений one_value может быть только одним из следующих:
int64 Value

string ( int64 format)

Целое значение

double Value

number

Двойное значение

МеждуФильтр

Чтобы выразить это, результат должен находиться между двумя числами (включительно).

JSON-представление 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Поля
from Value

object ( NumericValue )

Начинается с этого номера.

to Value

object ( NumericValue )

Заканчивается этим номером.

ПустойФильтр

Этот тип не имеет полей.

Фильтровать пустые значения.

Агрегация показателей

Представляет агрегирование метрик.

Перечисления
METRIC_AGGREGATION_UNSPECIFIED Неопределенный оператор.
TOTAL Оператор СУММ.
MINIMUM Минимальный оператор.
MAXIMUM Максимальный оператор.
COUNT Оператор счета.

Заказ по

Order bys определяет, как будут сортироваться строки в ответе. Например, упорядочивание строк по убыванию количества событий — это один порядок, а упорядочивание строк по строке имени события — другой порядок.

JSON-представление 
{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}
Поля
desc

boolean

Если true, сортируется по убыванию.

Поле объединения one_order_by . Укажите один тип заказа для OrderBy . one_order_by может быть только одним из следующих:
metric

object ( MetricOrderBy )

Сортирует результаты по значениям метрики.

dimension

object ( DimensionOrderBy )

Сортирует результаты по значениям измерения.

MetricOrderBy

Сортировка по значениям показателей.

JSON-представление 
{
  "metricName": string
}
Поля
metric Name

string

Имя метрики в запросе для сортировки.

DimensionOrderBy

Сортировка по значениям измерений.

JSON-представление 
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
Поля
dimension Name

string

Имя измерения в запросе на упорядочивание.

order Type

enum ( OrderType )

Управляет правилом упорядочивания значений измерения.

Тип заказа

Правило для упорядочивания значений размеров строки.

Перечисления
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 (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Поля
cohorts[]

object ( Cohort )

Определяет критерии отбора для группировки пользователей в когорты.

В большинстве отчетов о когортах определяется только одна когорта. Если указано несколько когорт, каждая когорта может быть распознана в отчете по названию.

cohorts Range

object ( CohortsRange )

Отчеты по когортам следуют за когортами за расширенный диапазон дат отчетности. Этот диапазон определяет продолжительность смещения для отслеживания когорт.

cohort Report Settings

object ( CohortReportSettings )

Дополнительные настройки для когортного отчета.

когорта

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

JSON-представление 
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
Поля
name

string

Присваивает имя этой когорте. cohort измерения оценивается по этому имени в ответе на отчет. Если установлено, не может начинаться с cohort_ или RESERVED_ . Если этот параметр не установлен, когорты именуются по индексу, отсчитываемому от нуля, cohort_0 , cohort_1 и т. д.

dimension

string

Измерение, используемое когортой. Требуется и поддерживает только firstSessionDate .

date Range

object ( DateRange )

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

В запросе когорты этот dateRange является обязательным, а dateRanges в RunReportRequest или RunPivotReportRequest не должны быть указаны.

Этот dateRange обычно должен соответствовать степени детализации когорты. Если CohortsRange использует дневную детализацию, этот dateRange может быть одним днем. Если CohortsRange использует еженедельную детализацию, этот dateRange можно выровнять по границе недели, начиная с воскресенья и заканчивая субботой. Если CohortsRange использует детализацию по месяцам, этот dateRange можно выровнять по месяцу, начиная с первого и заканчивая последним днем ​​месяца.

КогортыДиапазон

Настраивает расширенный диапазон дат отчета для когортного отчета. Указывает продолжительность смещения для отслеживания когорт.

JSON-представление 
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Поля
granularity

enum ( Granularity )

Необходимый. Степень детализации, используемая для интерпретации значений startOffset и endOffset для расширенного диапазона дат отчетности для когортного отчета.

start Offset

integer

startOffset указывает дату начала расширенного диапазона дат отчетности для когортного отчета. startOffset обычно устанавливается значение 0, чтобы отчеты содержали данные о приобретении следующей когорты.

Если granularity равен DAILY , startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset дни.

Если granularity равен WEEKLY , startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset * 7 дней.

Если granularity равен MONTHLY , startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset * 30 дней.

end Offset

integer

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

Если granularity равна DAILY , endDate расширенного диапазона дат отчетности равна endDate когорты плюс дни endOffset .

Если granularity равен WEEKLY , endDate расширенного диапазона дат отчетности равен endDate когорты плюс endOffset * 7 дней.

Если granularity равен MONTHLY , endDate расширенного диапазона дат отчетности равен endDate когорты плюс endOffset * 30 дней.

Детализация

Степень детализации, используемая для интерпретации значений startOffset и endOffset для расширенного диапазона дат отчетности для когортного отчета.

Перечисления
GRANULARITY_UNSPECIFIED Никогда не следует указывать.
DAILY Ежедневная детализация. Обычно используется, если dateRange когорты равен одному дню и запрос содержит cohortNthDay .
WEEKLY Еженедельная детализация. Обычно используется, если dateRange когорты длится неделю (начиная с воскресенья и заканчивая в субботу), а запрос содержит cohortNthWeek .
MONTHLY Месячная детализация. Обычно используется, если dateRange когорты имеет продолжительность месяц и запрос содержит cohortNthMonth .

Настройки отчета когорты

Дополнительные настройки когортного отчета.

JSON-представление 
{
  "accumulate": boolean
}
Поля
accumulate

boolean

Если это правда, накапливается результат от первого дня касания до конечного дня. Не поддерживается в RunReportRequest .

Уровень выборки

Категории уровней выборки для запросов.

Перечисления
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 (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
Поля
creation Quota Tokens Charged

integer

Только вывод. Общая сумма токенов квоты, начисленная при создании отчета. Поскольку это количество токенов основано на активности из состояния CREATING , плата за эти токены будет фиксированной, как только задача отчета перейдет в состояние ACTIVE или FAILED .

state

enum ( State )

Только вывод. Текущее состояние этой задачи отчета.

begin Creating Time

string ( Timestamp format)

Только вывод. Время, когда был вызван reportTasks.create и отчет перешел в состояние CREATING .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

task Row Count

integer

Только вывод. Общее количество строк в результате отчета. Это поле будет заполнено, когда состояние активно. Вы можете использовать taskRowCount для разбиения на страницы в пределах существующего отчета.

error Message

string

Только вывод. Сообщение об ошибке отображается, если задача отчета завершается сбоем во время создания.

total Row Count

integer

Только вывод. Общее количество строк в хранилище Google Analytics. Если вы хотите запросить дополнительные строки данных помимо текущего отчета, они могут инициировать новую задачу отчета на основе totalRowCount .

taskRowCount представляет количество строк, конкретно относящихся к текущему отчету, тогда как totalRowCount включает общее количество строк во всех данных, полученных из хранилища Google Analytics.

Например, предположим, что taskRowCount текущего отчета равен 20 и отображает данные из первых 20 строк. При этом totalRowCount равен 30, что указывает на наличие данных для всех 30 строк. taskRowCount можно использовать для разбивки по страницам первых 20 строк. Чтобы расширить отчет и включить данные из всех 30 строк, можно создать новую задачу отчета с помощью totalRowCount для доступа к полному набору данных из 30 строк.

Состояние

Состояние обработки.

Перечисления
STATE_UNSPECIFIED Неопределенное состояние никогда не будет использоваться.
CREATING Отчет в настоящее время создается и будет доступен в будущем. Создание происходит сразу после вызова CreateReport.
ACTIVE Отчет полностью создан и готов к запросам.
FAILED Не удалось создать отчет.

Методы

create

 Инициирует создание задачи отчета.

get

 Получает метаданные отчета о конкретной задаче отчета.

list

 Перечисляет все задачи отчета для свойства.

query

 Получает содержимое задачи отчета.
,

Ресурс: ReportTask

Конкретная конфигурация задачи отчета.

JSON-представление 
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
Поля
name

string

Только вывод. Идентификатор. Имя ресурса задачи отчета, назначенное при создании. Формат: «свойства/{свойство}/reportTasks/{reportTask}»

report Definition

object ( ReportDefinition )

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

report Metadata

object ( ReportMetadata )

Только вывод. Метаданные отчета для конкретной задачи отчета, которые предоставляют информацию об отчете. Обычно он включает следующую информацию: имя ресурса отчета, состояние отчета, временную метку создания отчета и т. д.

Определение отчета

Определение того, как следует запускать отчет.

JSON-представление 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "samplingLevel": enum (SamplingLevel)
}
Поля
dimensions[]

object ( Dimension )

Необязательный. Запрошенные и отображенные размеры.

metrics[]

object ( Metric )

Необязательный. Запрошенные и отображаемые метрики.

date Ranges[]

object ( DateRange )

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

dimension Filter

object ( FilterExpression )

Необязательный. Фильтры измерений позволяют запрашивать в отчете только определенные значения измерений. Дополнительные сведения см. в разделе «Основы фильтров измерений» . В этом фильтре нельзя использовать метрики.

metric Filter

object ( FilterExpression )

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

offset

string ( int64 format)

Необязательный. Количество строк в начальной строке из хранилища Google Analytics. Первая строка считается строкой 0.

При создании задачи отчета параметры offset и limit определяют подмножество строк данных из хранилища Google Analytics, которые будут включены в созданный отчет. Например, если в хранилище Google Analytics всего 300 000 строк, первоначальная задача отчета может содержать первые 10 000 строк с ограничением в 10 000 и смещением 0. Впоследствии другая задача отчета может охватывать следующие 10 000 строк с помощью лимит 10 000 и смещение 10 000.

limit

string ( int64 format)

Необязательный. Количество строк, возвращаемых в отчете. Если не указано, возвращается 10 000 строк. API возвращает максимум 250 000 строк на запрос, независимо от того, сколько вы запрашиваете. limit должен быть положительным.

API также может возвращать меньше строк, чем запрошенное limit , если значений измерения не так много, как limit . Например, для параметра country существует менее 300 возможных значений, поэтому при составлении отчета только по country вы не сможете получить более 300 строк, даже если вы установите limit на более высокое значение.

metric Aggregations[]

enum ( MetricAggregation )

Необязательный. Агрегация метрик. Агрегированные значения показателей будут отображаться в строках, где для параметра DimensionValues ​​установлено значение «RESERVED_(MetricAggregation)».

order Bys[]

object ( OrderBy )

Необязательный. Указывает, как упорядочены строки в ответе.

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.

sampling Level

enum ( SamplingLevel )

Необязательный. Уровень выборки отчета.

Измерение

Измерения — это атрибуты ваших данных. Например, параметр «Город» указывает город, из которого происходит событие. Значения измерений в ответах отчета представляют собой строки; например, городом может быть «Париж» или «Нью-Йорк».

JSON-представление 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
Поля
name

string

Имя измерения. См. раздел «Измерения API» для получения списка имен измерений, поддерживаемых основными методами отчетности, такими как runReport batchRunReports . Список имен измерений, поддерживаемых методом runRealtimeReport , см. в разделе «Измерения реального времени» . См. раздел «Измерения последовательности» для получения списка имен измерений, поддерживаемых методом runFunnelReport .

Если dimensionExpression указан, name может быть любой строкой в ​​разрешенном наборе символов. Например, если dimensionExpression объединяет country и city , вы можете назвать это измерение countryAndCity . Выбранные вами имена измерений должны соответствовать регулярному выражению ^[a-zA-Z0-9_]$ .

На измерения ссылаются по name в dimensionFilter , orderBys , dimensionExpression и pivots .

dimension Expression

object ( DimensionExpression )

Одно измерение может быть результатом выражения нескольких измерений. Например, измерение «страна, город»: concatenate(country, «, «, city).

Выражение Измерения

Используется для выражения измерения, которое является результатом формулы нескольких измерений. Примеры использования: 1) нижний регистр (размерность) 2) объединение (размерность1, символ, размерность2).

JSON-представление 
{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}
Поля
Поле объединения one_expression . Укажите один тип выражения измерения для DimensionExpression . one_expression может быть только одним из следующих:
lower Case

object ( CaseExpression )

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

upper Case

object ( CaseExpression )

Используется для преобразования значения размера в верхний регистр.

concatenate

object ( ConcatenateExpression )

Используется для объединения значений измерения в одно измерение. Например, измерение «страна, город»: concatenate(country, «, «, city).

Выражение случая

Используется для преобразования значения измерения в один случай.

JSON-представление 
{
  "dimensionName": string
}
Поля
dimension Name

string

Имя измерения. Имя должно ссылаться на имя в поле размеров запроса.

ОбъединитьВыражение

Используется для объединения значений измерения в одно измерение.

JSON-представление 
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Поля
dimension Names[]

string

Названия размеров. Имена должны ссылаться на имена в поле измерений запроса.

delimiter

string

Разделитель, помещаемый между именами измерений.

Разделителями часто являются одиночные символы, такие как «|». или «,», но могут быть и более длинными строками. Если значение измерения содержит разделитель, в ответе будут присутствовать оба без различия. Например, если значение параметра 1 = «US,FR», значение параметра 2 = «JP» и разделитель = «,», то ответ будет содержать «US,FR,JP».

Метрика

Количественные измерения отчета. Например, метрика eventCount — это общее количество событий. Запросы разрешены до 10 метрик.

JSON-представление 
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Поля
name

string

Имя метрики. См. раздел «Метрики API» для получения списка имен метрик, поддерживаемых основными методами отчетности, такими как runReport batchRunReports . См . раздел «Метрики реального времени» , где приведен список имен метрик, поддерживаемых методом runRealtimeReport . См. раздел «Метрики последовательности» для получения списка имен метрик, поддерживаемых методом runFunnelReport .

Если указано expression , name может быть любая строка в разрешенном наборе символов. Например, если expression — screenPageViews/sessions , вы можете назвать эту метрику = viewsPerSession . Имена метрик, которые вы выбираете, должны соответствовать регулярному выражению ^[a-zA-Z0-9_]$ .

На метрики ссылаются по name в metricFilter , orderBys и expression метрики.

expression

string

Математическое выражение для производных показателей. Например, метрика «Количество событий на пользователя» — eventCount/totalUsers .

invisible

boolean

Указывает, невидима ли метрика в ответе отчета. Если метрика невидима, она не будет создавать столбец в ответе, но ее можно использовать в metricFilter , orderBys или expression метрики.

Диапазон дат

Непрерывный набор дней: startDate , startDate + 1 , ..., endDate . Запросы разрешены до 4 диапазонов дат.

JSON-представление 
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Поля
start Date

string

Включительная дата начала запроса в формате YYYY-MM-DD . Не может быть после endDate . Формат NdaysAgo , yesterday или today также принимается, и в этом случае дата определяется на основе часового пояса, в котором указан ресурс.

end Date

string

Включительная дата окончания запроса в формате YYYY-MM-DD . Не может быть раньше startDate . Формат NdaysAgo , yesterday или today также принимается, и в этом случае дата определяется на основе часового пояса, в котором указан ресурс.

name

string

Присваивает имя этому диапазону дат. Измерение dateRange оценивается по этому имени в ответе отчета. Если установлено, не может начинаться с date_range_ или RESERVED_ . Если этот параметр не установлен, диапазоны дат именуются по индексу, начинающемуся с нуля, в запросе: date_range_0 , date_range_1 и т. д.

Выражение фильтра

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

JSON-представление 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз полевых expr . Укажите один тип выражения фильтра для FilterExpression . expr может быть только одним из следующих:
and Group

object ( FilterExpressionList )

Выражения FilterExpressions в andGroup имеют отношение AND.

or Group

object ( FilterExpressionList )

Выражения FilterExpressions в orGroup имеют отношение ИЛИ.

not Expression

object ( FilterExpression )

FilterExpression НЕ является выражением notExpression.

filter

object ( Filter )

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

Список выражений фильтра

Список выражений фильтра.

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

object ( FilterExpression )

Список выражений фильтра.

Фильтр

Выражение для фильтрации значений параметра или показателя.

JSON-представление 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of list of possible types for union field one_filter.
}
Поля
field Name

string

Имя измерения или имя метрики. Должно быть имя, определенное в параметрах или показателях.

Поле объединения one_filter . Укажите один тип фильтра для Filter . one_filter может быть только одним из следующих:
string Filter

object ( StringFilter )

Фильтр, связанный со строками.

in List Filter

object ( InListFilter )

Фильтр для значений в списке.

numeric Filter

object ( NumericFilter )

Фильтр для числовых значений или значений даты.

between Filter

object ( BetweenFilter )

Фильтр между двумя значениями.

empty Filter

object ( EmptyFilter )

Фильтр для пустых значений, таких как значения «(не установлено)» и «».

Строковый фильтр

Фильтр для строки

JSON-представление 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Поля
match Type

enum ( MatchType )

Тип соответствия для этого фильтра.

value

string

Строковое значение, используемое для сопоставления.

case Sensitive

boolean

Если это правда, строковое значение чувствительно к регистру.

Тип соответствия

Тип соответствия строкового фильтра

Перечисления
MATCH_TYPE_UNSPECIFIED Не указано
EXACT Точное совпадение строкового значения.
BEGINS_WITH Начинается со строкового значения.
ENDS_WITH Заканчивается строковым значением.
CONTAINS Содержит строковое значение.
FULL_REGEXP Полное совпадение регулярного выражения со строковым значением.
PARTIAL_REGEXP Частичное совпадение регулярного выражения со строковым значением.

Инлистфильтр

Результат должен быть в списке строковых значений.

JSON-представление 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Поля
values[]

string

Список строковых значений. Должно быть непусто.

case Sensitive

boolean

Если это правда, строковое значение чувствительно к регистру.

ЧисловойФильтр

Фильтры для числовых значений или значений даты.

JSON-представление 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Поля
operation

enum ( Operation )

Тип операции для этого фильтра.

value

object ( NumericValue )

Числовое значение или значение даты.

Операция

Операция, примененная к числовому фильтру

Перечисления
OPERATION_UNSPECIFIED Не указано.
EQUAL Равный
LESS_THAN Меньше, чем
LESS_THAN_OR_EQUAL Меньше или равно
GREATER_THAN Больше, чем
GREATER_THAN_OR_EQUAL Больше или равно

Числовое значение

Чтобы представить число.

JSON-представление 
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
Поля
Поле объединения one_value . Одно из числовых значений one_value может быть только одним из следующих:
int64 Value

string ( int64 format)

Целое значение

double Value

number

Двойное значение

МеждуФильтр

Чтобы выразить это, результат должен находиться между двумя числами (включительно).

JSON-представление 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Поля
from Value

object ( NumericValue )

Начинается с этого номера.

to Value

object ( NumericValue )

Заканчивается этим номером.

ПустойФильтр

Этот тип не имеет полей.

Фильтровать пустые значения.

Агрегация показателей

Представляет агрегирование метрик.

Перечисления
METRIC_AGGREGATION_UNSPECIFIED Неопределенный оператор.
TOTAL Оператор СУММ.
MINIMUM Минимальный оператор.
MAXIMUM Максимальный оператор.
COUNT Оператор счета.

Заказ по

Порядок по определяет, как будут сортироваться строки в ответе. Например, упорядочивание строк по убыванию количества событий — это один порядок, а упорядочивание строк по строке имени события — это другой порядок.

JSON-представление 
{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}
Поля
desc

boolean

Если true, сортируется по убыванию.

Поле объединения one_order_by . Укажите один тип заказа для OrderBy . one_order_by может быть только одним из следующих:
metric

object ( MetricOrderBy )

Сортирует результаты по значениям метрики.

dimension

object ( DimensionOrderBy )

Сортирует результаты по значениям измерения.

MetricOrderBy

Сортировка по значениям показателей.

JSON-представление 
{
  "metricName": string
}
Поля
metric Name

string

Имя метрики в запросе для сортировки.

DimensionOrderBy

Сортировка по значениям измерений.

JSON-представление 
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
Поля
dimension Name

string

Имя измерения в запросе на упорядочивание.

order Type

enum ( OrderType )

Управляет правилом упорядочивания значений измерения.

Тип заказа

Правило для упорядочивания значений размеров строки.

Перечисления
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 (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Поля
cohorts[]

object ( Cohort )

Определяет критерии отбора для группировки пользователей в когорты.

В большинстве отчетов о когортах определяется только одна когорта. Если указано несколько когорт, каждая когорта может быть распознана в отчете по названию.

cohorts Range

object ( CohortsRange )

Отчеты по когортам следуют за когортами за расширенный диапазон дат отчетности. Этот диапазон определяет продолжительность смещения для отслеживания когорт.

cohort Report Settings

object ( CohortReportSettings )

Дополнительные настройки для когортного отчета.

когорта

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

JSON-представление 
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
Поля
name

string

Присваивает имя этой когорте. cohort измерения оценивается по этому имени в ответе на отчет. Если установлено, не может начинаться с cohort_ или RESERVED_ . Если этот параметр не установлен, когорты именуются по индексу, отсчитываемому от нуля, cohort_0 , cohort_1 и т. д.

dimension

string

Измерение, используемое когортой. Требуется и поддерживает только firstSessionDate .

date Range

object ( DateRange )

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

В запросе когорты этот dateRange является обязательным, а dateRanges в RunReportRequest или RunPivotReportRequest не должны быть указаны.

Этот dateRange обычно должен соответствовать степени детализации когорты. Если CohortsRange использует дневную детализацию, этот dateRange может быть одним днем. Если CohortsRange использует еженедельную детализацию, этот dateRange можно выровнять по границе недели, начиная с воскресенья и заканчивая субботой. Если CohortsRange использует детализацию по месяцам, этот dateRange можно выровнять по месяцу, начиная с первого и заканчивая последним днем ​​месяца.

КогортыДиапазон

Настраивает расширенный диапазон дат отчета для когортного отчета. Указывает продолжительность смещения для отслеживания когорт.

JSON-представление 
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Поля
granularity

enum ( Granularity )

Необходимый. Степень детализации, используемая для интерпретации значений startOffset и endOffset для расширенного диапазона дат отчетности для когортного отчета.

start Offset

integer

startOffset указывает дату начала расширенного диапазона дат отчетности для когортного отчета. startOffset обычно устанавливается значение 0, чтобы отчеты содержали данные о приобретении следующей когорты.

Если granularity равен DAILY , startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset дни.

Если granularity равен WEEKLY , startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset * 7 дней.

Если granularity равен MONTHLY , startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset * 30 дней.

end Offset

integer

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

Если granularity равна DAILY , endDate расширенного диапазона дат отчетности равна endDate когорты плюс дни endOffset .

Если granularity равен WEEKLY , endDate расширенного диапазона дат отчетности равен endDate когорты плюс endOffset * 7 дней.

Если granularity равен MONTHLY , endDate расширенного диапазона дат отчетности равен endDate когорты плюс endOffset * 30 дней.

Детализация

Степень детализации, используемая для интерпретации значений startOffset и endOffset для расширенного диапазона дат отчетности для когортного отчета.

Перечисления
GRANULARITY_UNSPECIFIED Никогда не следует указывать.
DAILY Ежедневная детализация. Обычно используется, если dateRange когорты равен одному дню и запрос содержит cohortNthDay .
WEEKLY Еженедельная детализация. Обычно используется, если dateRange когорты длится неделю (начиная с воскресенья и заканчивая в субботу), а запрос содержит cohortNthWeek .
MONTHLY Месячная детализация. Обычно используется, если dateRange когорты имеет продолжительность месяц и запрос содержит cohortNthMonth .

Настройки отчета когорты

Дополнительные настройки когортного отчета.

JSON-представление 
{
  "accumulate": boolean
}
Поля
accumulate

boolean

Если это правда, накапливается результат от первого дня касания до конечного дня. Не поддерживается в RunReportRequest .

Уровень выборки

Категории уровней выборки для запросов.

Перечисления
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 (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
Поля
creation Quota Tokens Charged

integer

Только вывод. Общая сумма токенов квоты, начисленная при создании отчета. Поскольку это количество токенов основано на активности из состояния CREATING , плата за эти токены будет фиксированной, как только задача отчета перейдет в состояние ACTIVE или FAILED .

state

enum ( State )

Только вывод. Текущее состояние этой задачи отчета.

begin Creating Time

string ( Timestamp format)

Только вывод. Время, когда был вызван reportTasks.create и отчет перешел в состояние CREATING .

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

task Row Count

integer

Только вывод. Общее количество строк в результате отчета. Это поле будет заполнено, когда состояние активно. Вы можете использовать taskRowCount для разбиения на страницы в пределах существующего отчета.

error Message

string

Только вывод. Сообщение об ошибке отображается, если задача отчета завершается сбоем во время создания.

total Row Count

integer

Только вывод. Общее количество строк в хранилище Google Analytics. Если вы хотите запросить дополнительные строки данных помимо текущего отчета, они могут инициировать новую задачу отчета на основе totalRowCount .

taskRowCount представляет количество строк, конкретно относящихся к текущему отчету, тогда как totalRowCount включает общее количество строк во всех данных, полученных из хранилища Google Analytics.

Например, предположим, что taskRowCount текущего отчета равен 20 и отображает данные из первых 20 строк. При этом totalRowCount равен 30, что указывает на наличие данных для всех 30 строк. taskRowCount можно использовать для разбивки по страницам первых 20 строк. Чтобы расширить отчет и включить данные из всех 30 строк, можно создать новую задачу отчета с помощью totalRowCount для доступа к полному набору данных из 30 строк.

Состояние

Состояние обработки.

Перечисления
STATE_UNSPECIFIED Неопределенное состояние никогда не будет использоваться.
CREATING Отчет в настоящее время создается и будет доступен в будущем. Создание происходит сразу после вызова CreateReport.
ACTIVE Отчет полностью создан и готов к запросам.
FAILED Не удалось создать отчет.

Методы

create

 Инициирует создание задачи отчета.

get

 Получает метаданные отчета о конкретной задаче отчета.

list

 Перечисляет все задачи отчета для свойства.

query

 Получает содержимое задачи отчета.
,

Ресурс: ReportTask

Конкретная конфигурация задачи отчета.

JSON-представление 
{
  "name": string,
  "reportDefinition": {
    object (ReportDefinition)
  },
  "reportMetadata": {
    object (ReportMetadata)
  }
}
Поля
name

string

Только вывод. Идентификатор. Имя ресурса задачи отчета, назначенное при создании. Формат: «свойства/{свойство}/reportTasks/{reportTask}»

report Definition

object ( ReportDefinition )

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

report Metadata

object ( ReportMetadata )

Только вывод. Метаданные отчета для конкретной задачи отчета, которые предоставляют информацию об отчете. Обычно он включает следующую информацию: имя ресурса отчета, состояние отчета, временную метку создания отчета и т. д.

Определение отчета

Определение того, как следует запускать отчет.

JSON-представление 
{
  "dimensions": [
    {
      object (Dimension)
    }
  ],
  "metrics": [
    {
      object (Metric)
    }
  ],
  "dateRanges": [
    {
      object (DateRange)
    }
  ],
  "dimensionFilter": {
    object (FilterExpression)
  },
  "metricFilter": {
    object (FilterExpression)
  },
  "offset": string,
  "limit": string,
  "metricAggregations": [
    enum (MetricAggregation)
  ],
  "orderBys": [
    {
      object (OrderBy)
    }
  ],
  "currencyCode": string,
  "cohortSpec": {
    object (CohortSpec)
  },
  "keepEmptyRows": boolean,
  "samplingLevel": enum (SamplingLevel)
}
Поля
dimensions[]

object ( Dimension )

Необязательный. Запрошенные и отображенные размеры.

metrics[]

object ( Metric )

Необязательный. Запрошенные и отображаемые метрики.

date Ranges[]

object ( DateRange )

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

dimension Filter

object ( FilterExpression )

Необязательный. Фильтры измерений позволяют запрашивать в отчете только определенные значения измерений. Дополнительные сведения см. в разделе «Основы фильтров измерений» . В этом фильтре нельзя использовать метрики.

metric Filter

object ( FilterExpression )

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

offset

string ( int64 format)

Необязательный. Количество строк в начальной строке из хранилища Google Analytics. Первая строка считается строкой 0.

При создании задачи отчета параметры offset и limit определяют подмножество строк данных из хранилища Google Analytics, которые будут включены в созданный отчет. Например, если в хранилище Google Analytics всего 300 000 строк, первоначальная задача отчета может содержать первые 10 000 строк с ограничением в 10 000 и смещением 0. Впоследствии другая задача отчета может охватывать следующие 10 000 строк с помощью лимит 10 000 и смещение 10 000.

limit

string ( int64 format)

Необязательный. Количество строк, возвращаемых в отчете. Если не указано, возвращается 10 000 строк. API возвращает максимум 250 000 строк на запрос, независимо от того, сколько вы запрашиваете. limit должен быть положительным.

API также может возвращать меньше строк, чем запрошенное limit , если значений измерения не так много, как limit . Например, для параметра country существует менее 300 возможных значений, поэтому при составлении отчета только по country вы не сможете получить более 300 строк, даже если вы установите limit на более высокое значение.

metric Aggregations[]

enum ( MetricAggregation )

Необязательный. Агрегация метрик. Агрегированные значения показателей будут отображаться в строках, где для параметра DimensionValues ​​установлено значение «RESERVED_(MetricAggregation)».

order Bys[]

object ( OrderBy )

Необязательный. Указывает, как упорядочены строки в ответе.

currency Code

string

Необязательный. Код валюты в формате ISO4217, например «AED», «USD», «JPY». Если поле пусто, в отчете используется валюта ресурса по умолчанию.

cohort Spec

object ( CohortSpec )

Необязательный. Когортная группа, связанная с этим запросом. Если в запросе есть когортная группа, параметр «когорта» должен присутствовать.

keep Empty Rows

boolean

Необязательный. Если значение false или не указано, каждая строка со всеми метриками, равными 0, не будет возвращена. Если это правда, эти строки будут возвращены, если они не будут удалены фильтром отдельно.

Независимо от этого параметра keepEmptyRows , в отчете могут отображаться только данные, записанные свойством Google Analytics.

Например, если свойство никогда не регистрирует событие purchase , то запрос для eventName Dimension и eventCount Metric не будет иметь строки, содержащей EventName: «Покупка» и EventCount: 0.

sampling Level

enum ( SamplingLevel )

Необязательный. Уровень отбора отчета.

Измерение

Размеры являются атрибутами ваших данных. Например, город измерения указывает на город, из которого происходит событие. Значения измерений в ответах отчета - это строки; Например, город может быть «Париж» или «Нью -Йорк».

JSON-представление 
{
  "name": string,
  "dimensionExpression": {
    object (DimensionExpression)
  }
}
Поля
name

string

Название измерения. См. Размеры API для списка имен измерений, поддерживаемых основными методами отчетности, такими как runReport и batchRunReports . См. Размеры в реальном времени для списка имен измерений, поддерживаемых методом runRealtimeReport . См. Размеры воронки для списка имен измерений, поддерживаемых методом runFunnelReport .

Если указан dimensionExpression , name может быть любой строкой, которую вы хотели бы в разрешенном наборе символов. Например, если dimensionExpression объединяет country и city , вы можете назвать это измерением countryAndCity . Имена измерений, которые вы выбираете, должны соответствовать регулярному выражению ^[a-zA-Z0-9_]$ .

Размеры ссылаются по name в dimensionFilter , orderBys , dimensionExpression и pivots .

dimension Expression

object ( DimensionExpression )

Одно измерение может быть результатом выражения множества измерений. Например, измерение «Страна, город»: Concatenate (страна, «», город).

DimensionExpression

Используется для выражения измерения, которое является результатом формулы множественных измерений. Примеры использования: 1) нижний суд (размер) 2) Конкатенат (размер 1, символ, размер2).

JSON-представление 
{

  // Union field one_expression can be only one of the following:
  "lowerCase": {
    object (CaseExpression)
  },
  "upperCase": {
    object (CaseExpression)
  },
  "concatenate": {
    object (ConcatenateExpression)
  }
  // End of list of possible types for union field one_expression.
}
Поля
Поле Союза one_expression . Укажите один тип выражения измерения для DimensionExpression . one_expression может быть только одним из следующих:
lower Case

object ( CaseExpression )

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

upper Case

object ( CaseExpression )

Используется для преобразования значения измерения в верхний регистр.

concatenate

object ( ConcatenateExpression )

Используется для объединения значений измерений до одного измерения. Например, измерение «Страна, город»: Concatenate (страна, «», город).

Casexpression

Используется для преобразования значения измерения в один случай.

JSON-представление 
{
  "dimensionName": string
}
Поля
dimension Name

string

Название измерения. Имя должно вернуться к полю имени в размерах запроса.

ConcatenateExpression

Используется для объединения значений измерений до одного измерения.

JSON-представление 
{
  "dimensionNames": [
    string
  ],
  "delimiter": string
}
Поля
dimension Names[]

string

Названия измерений. Имена должны относиться к именам в поле Damensions запроса.

delimiter

string

Разделитель расположен между именами измерений.

Разделители часто являются отдельными персонажами, такими как "|" или ",", но может быть более длинные строки. Если значение измерения содержит разделитель, оба будут присутствовать в ответ без различий. Например, если Dimension 1 value = "US, FR", Dimension 2 value = "jp" и delimiter = ",", тогда ответ будет содержать "US, FR, JP".

Метрика

Количественные измерения отчета. Например, Metric eventCount - это общее количество событий. Запросы допускаются до 10 метрик.

JSON-представление 
{
  "name": string,
  "expression": string,
  "invisible": boolean
}
Поля
name

string

Название метрики. См. Метрики API для списка метрических имен, поддерживаемых основными методами отчетности, такими как runReport и batchRunReports . См. Метрики в реальном времени для списка метрических имен, поддерживаемых методом runRealtimeReport . См. Метрики воронки для списка метрических имен, поддерживаемых методом runFunnelReport .

Если указано expression , name может быть любой строкой, которую вы хотели бы в разрешенном наборе символов. Например, если expression является screenPageViews/sessions , вы можете назвать этот метрика name = viewsPerSession . Метрические имена, которые вы выбираете, должны соответствовать регулярному выражению ^[a-zA-Z0-9_]$ .

На метрики ссылаются name в metricFilter , orderBys и метрическом expression .

expression

string

Математическое выражение для полученных метрик. Например, количество метрических событий на одного пользователя - eventCount/totalUsers .

invisible

boolean

Указывает, является ли метрика невидимой в ответе отчета. Если метрика невидима, метрика не будет производить столбец в ответе, но может использоваться в metricFilter , orderBys или метрическом expression .

Запасной

Сметный набор дней: startDate , startDate + 1 , ..., endDate . Запросы допускаются до 4 датчиков.

JSON-представление 
{
  "startDate": string,
  "endDate": string,
  "name": string
}
Поля
start Date

string

Инклюзивная дата начала для запроса в формате YYYY-MM-DD . Не может быть после endDate . Формат NdaysAgo , yesterday или today также принимается, и в этом случае дата выведена на основе часового пояс отчетности имущества.

end Date

string

Инклюзивная дата окончания запроса в формате YYYY-MM-DD . Не может быть до startDate . Формат NdaysAgo , yesterday или today также принимается, и в этом случае дата выведена на основе часового пояс отчетности имущества.

name

string

Назначает имя в этот диапазон дат. Dimension dateRange оценен этим именем в ответе отчета. Если установлено, не может начать с date_range_ или RESERVED_ . Если не установлено, диапазоны даты названы их индексом на основе нуля в запросе: date_range_0 , date_range_1 и т. Д.

FilterExpression

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

JSON-представление 
{

  // Union field expr can be only one of the following:
  "andGroup": {
    object (FilterExpressionList)
  },
  "orGroup": {
    object (FilterExpressionList)
  },
  "notExpression": {
    object (FilterExpression)
  },
  "filter": {
    object (Filter)
  }
  // End of list of possible types for union field expr.
}
Поля
Союз Филд expr . Укажите один тип выражения фильтра для FilterExpression . expr может быть только одним из следующих:
and Group

object ( FilterExpressionList )

FilterExpressions в Andgroup имеют и отношения.

or Group

object ( FilterExpressionList )

FilterExpressions в Orgroup имеют или отношения.

not Expression

object ( FilterExpression )

FilterExpression не является неэкспрессией.

filter

object ( Filter )

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

FilterExpressionList

Список выражений фильтра.

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

object ( FilterExpression )

Список выражений фильтра.

Фильтр

Выражение для фильтрации измерения или значений метрики.

JSON-представление 
{
  "fieldName": string,

  // Union field one_filter can be only one of the following:
  "stringFilter": {
    object (StringFilter)
  },
  "inListFilter": {
    object (InListFilter)
  },
  "numericFilter": {
    object (NumericFilter)
  },
  "betweenFilter": {
    object (BetweenFilter)
  },
  "emptyFilter": {
    object (EmptyFilter)
  }
  // End of list of possible types for union field one_filter.
}
Поля
field Name

string

Имя измерения или метрическое имя. Должно быть имя, определенное в измерениях или метриках.

Поле Союза one_filter . Укажите один тип фильтра для Filter . one_filter может быть только одним из следующих:
string Filter

object ( StringFilter )

Строки, связанные с фильтром.

in List Filter

object ( InListFilter )

Фильтр для значений в списке.

numeric Filter

object ( NumericFilter )

Фильтр для числовых или значений даты.

between Filter

object ( BetweenFilter )

Фильтр для двух значений.

empty Filter

object ( EmptyFilter )

Фильтр для пустых значений, таких как «(не установлен)» и «значения».

StringFilter

Фильтр для строки

JSON-представление 
{
  "matchType": enum (MatchType),
  "value": string,
  "caseSensitive": boolean
}
Поля
match Type

enum ( MatchType )

Тип совпадения для этого фильтра.

value

string

Значение строки, используемое для сопоставления.

case Sensitive

boolean

Если true, строковое значение чувствителен к случаям.

Матча

Тип совпадения строкового фильтра

Перечисления
MATCH_TYPE_UNSPECIFIED Не указано
EXACT Точное совпадение строкового значения.
BEGINS_WITH Начинается со строкового значения.
ENDS_WITH Заканчивается со строковым значением.
CONTAINS Содержит строковое значение.
FULL_REGEXP Полное совпадение для регулярного выражения со строковым значением.
PARTIAL_REGEXP Частичное совпадение для регулярного выражения со строковым значением.

Inlistfilter

Результат должен быть в списке строковых значений.

JSON-представление 
{
  "values": [
    string
  ],
  "caseSensitive": boolean
}
Поля
values[]

string

Список строковых значений. Должен быть непустым.

case Sensitive

boolean

Если true, строковое значение чувствителен к случаям.

Числовойфильтер

Фильтры для числовых или значений даты.

JSON-представление 
{
  "operation": enum (Operation),
  "value": {
    object (NumericValue)
  }
}
Поля
operation

enum ( Operation )

Тип работы для этого фильтра.

value

object ( NumericValue )

Числовое значение или значение даты.

Операция

Операция, применяемая к численному фильтру

Перечисления
OPERATION_UNSPECIFIED Не указано.
EQUAL Равный
LESS_THAN Меньше, чем
LESS_THAN_OR_EQUAL Меньше или равно
GREATER_THAN Больше, чем
GREATER_THAN_OR_EQUAL Больше или равно

NumericValue

Представлять число.

JSON-представление 
{

  // Union field one_value can be only one of the following:
  "int64Value": string,
  "doubleValue": number
  // End of list of possible types for union field one_value.
}
Поля
Поле объединения one_value . Одним из числовых значений one_value может быть только одним из следующих:
int64 Value

string ( int64 format)

Целое значение

double Value

number

Двойное значение

Между фильтер

Чтобы выразить, что результат должен быть между двумя числами (включительно).

JSON-представление 
{
  "fromValue": {
    object (NumericValue)
  },
  "toValue": {
    object (NumericValue)
  }
}
Поля
from Value

object ( NumericValue )

Начинается с этого числа.

to Value

object ( NumericValue )

Заканчивается этим номером.

Пустогофильтера

Этот тип не имеет полей.

Фильтр для пустых значений.

Меткагрегация

Представляет агрегацию метрик.

Перечисления
METRIC_AGGREGATION_UNSPECIFIED Неуказанный оператор.
TOTAL Сумма оператора.
MINIMUM Минимальный оператор.
MAXIMUM Максимальный оператор.
COUNT Оператор графа.

Заказ по

Заказ BYS определяет, как строки будут отсортированы в ответе. Например, упорядочение рядов путем спуска спуска составляет один заказ, а заказ строк по имени события - это другой заказ.

JSON-представление 
{
  "desc": boolean,

  // Union field one_order_by can be only one of the following:
  "metric": {
    object (MetricOrderBy)
  },
  "dimension": {
    object (DimensionOrderBy)
  }
  // End of list of possible types for union field one_order_by.
}
Поля
desc

boolean

Если это правда, сортирует порядок спуска.

Поле Союза one_order_by . Укажите один тип заказа по OrderBy . one_order_by может быть только одним из следующих:
metric

object ( MetricOrderBy )

Сортируется результаты по значениям метрики.

dimension

object ( DimensionOrderBy )

Сортируется результаты по значениям измерения.

MetricOrderby

Сортируется по метрическим значениям.

JSON-представление 
{
  "metricName": string
}
Поля
metric Name

string

Метрическое имя в запросе на заказ.

DimensionOrderby

Сортируется по значениям измерений.

JSON-представление 
{
  "dimensionName": string,
  "orderType": enum (OrderType)
}
Поля
dimension Name

string

Имя измерения в запросе на заказ.

order Type

enum ( 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 (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Поля
cohorts[]

object ( Cohort )

Определяет критерии отбора для группировки пользователей в когорты.

В большинстве отчетов о когортах определяется только одна когорта. Если указано несколько когорт, каждая когорта может быть распознана в отчете по названию.

cohorts Range

object ( CohortsRange )

Отчеты по когортам следуют за когортами за расширенный диапазон дат отчетности. Этот диапазон определяет продолжительность смещения для отслеживания когорт.

cohort Report Settings

object ( CohortReportSettings )

Дополнительные настройки для когортного отчета.

когорта

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

JSON-представление 
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
Поля
name

string

Присваивает имя этой когорте. cohort измерения оценивается по этому имени в ответе на отчет. Если установлено, не может начинаться с cohort_ или RESERVED_ . Если этот параметр не установлен, когорты именуются по индексу, отсчитываемому от нуля, cohort_0 , cohort_1 и т. д.

dimension

string

Измерение, используемое когортой. Требуется и поддерживает только firstSessionDate .

date Range

object ( DateRange )

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

В запросе когорты этот dateRange является обязательным, а dateRanges в RunReportRequest или RunPivotReportRequest не должны быть указаны.

Этот dateRange обычно должен соответствовать степени детализации когорты. Если CohortsRange использует дневную детализацию, этот dateRange может быть одним днем. Если CohortsRange использует еженедельную детализацию, этот dateRange можно выровнять по границе недели, начиная с воскресенья и заканчивая субботой. Если CohortsRange использует детализацию по месяцам, этот dateRange можно выровнять по месяцу, начиная с первого и заканчивая последним днем ​​месяца.

КогортыДиапазон

Настраивает расширенный диапазон дат отчета для когортного отчета. Указывает продолжительность смещения для отслеживания когорт.

JSON-представление 
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Поля
granularity

enum ( Granularity )

Необходимый. Степень детализации, используемая для интерпретации значений startOffset и endOffset для расширенного диапазона дат отчетности для когортного отчета.

start Offset

integer

startOffset указывает дату начала расширенного диапазона дат отчетности для когортного отчета. startOffset обычно устанавливается значение 0, чтобы отчеты содержали данные о приобретении следующей когорты.

Если granularity равен DAILY , startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset дни.

Если granularity равен WEEKLY , startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset * 7 дней.

Если granularity равен MONTHLY , startDate расширенного диапазона дат отчетности равен startDate когорты плюс startOffset * 30 дней.

end Offset

integer

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

Если granularity равна DAILY , endDate расширенного диапазона дат отчетности равна endDate когорты плюс дни endOffset .

Если granularity равен WEEKLY , endDate расширенного диапазона дат отчетности равен endDate когорты плюс endOffset * 7 дней.

Если granularity равен MONTHLY , endDate расширенного диапазона дат отчетности равен endDate когорты плюс endOffset * 30 дней.

Детализация

Степень детализации, используемая для интерпретации значений startOffset и endOffset для расширенного диапазона дат отчетности для когортного отчета.

Перечисления
GRANULARITY_UNSPECIFIED Никогда не следует указывать.
DAILY Ежедневная детализация. Обычно используется, если dateRange когорты равен одному дню и запрос содержит cohortNthDay .
WEEKLY Еженедельная детализация. Обычно используется, если dateRange когорты длится неделю (начиная с воскресенья и заканчивая в субботу), а запрос содержит cohortNthWeek .
MONTHLY Месячная детализация. Обычно используется, если dateRange когорты имеет продолжительность месяц и запрос содержит cohortNthMonth .

Настройки отчета когорты

Дополнительные настройки когортного отчета.

JSON-представление 
{
  "accumulate": boolean
}
Поля
accumulate

boolean

Если это правда, накапливается результат от первого дня касания до конечного дня. Не поддерживается в RunReportRequest .

SAMPLINGLEVEL

Категории уровней отбора проб для запросов.

Перечисления
SAMPLING_LEVEL_UNSPECIFIED Неопределенный тип.
LOW Применяет уровень выборки 10 миллионов к стандартным свойствам и 100 миллионам свойств Google Analytics 360.
MEDIUM Эксклюзивно для свойств Google Analytics 360 с уровнем отбора проб 1 миллиард.
UNSAMPLED Эксклюзивный для Google Analytics 360 Properties. Несоответствующие исследования более точны и могут выявить понимание, которые не видны в стандартных исследованиях. Чтобы узнать больше, см. Https://support.google.com/analytics/answer/10896953 .

Reportmetadata

Отчет метаданных для конкретной задачи отчета.

JSON-представление 
{
  "creationQuotaTokensCharged": integer,
  "state": enum (State),
  "beginCreatingTime": string,
  "taskRowCount": integer,
  "errorMessage": string,
  "totalRowCount": integer
}
Поля
creation Quota Tokens Charged

integer

Только вывод. Общие токены квот, взимаемые во время создания отчета. Поскольку это количество токенов основано на деятельности из состояния CREATING , этот заряд токенов будет исправлена ​​после того, как задача отчета войдет в ACTIVE или FAILED состояние.

state

enum ( State )

Только вывод. Текущее состояние для выполнения задачи отчета.

begin Creating Time

string ( Timestamp format)

Только вывод. Время, когда было вызвано reportTasks.create , и отчет начал CREATING состояния.

Временная метка в формате RFC3339 UTC "Zulu" с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

task Row Count

integer

Только вывод. Общее количество строк в отчете результат. Это поле будет заполнено, когда государство активно. Вы можете использовать taskRowCount для страниц в пределах их существующего отчета.

error Message

string

Только вывод. Сообщение об ошибке заполнено, если задача отчета не выполняется во время создания.

total Row Count

integer

Только вывод. Общее количество строк в Google Analytics Storage. Если вы хотите запросить дополнительные строки данных за пределами текущего отчета, они могут инициировать новую задачу отчета на основе totalRowCount .

taskRowCount представляет количество строк, специально относящихся к текущему отчету, тогда как totalRowCount охватывает общее количество строк для всех данных, полученных из Google Analytics Storage.

Например, предположим, что текущий отчет taskRowCount составляет 20, отображая данные из первых 20 строк. Одновременно, totalRowCount составляет 30, что указывает на наличие данных для всех 30 строк. taskRowCount может быть использован для страниц через первоначальные 20 строк. Чтобы развернуть отчет и включить данные из всех 30 строк, новая задача отчета может быть создана с использованием TotalRowCount для доступа к полному набору данных из 30 строк.

Состояние

Состояние обработки.

Перечисления
STATE_UNSPECIFIED Непоказанное состояние никогда не будет использоваться.
CREATING Отчет в настоящее время создает и будет доступен в будущем. Создание происходит сразу после звонка Createreport.
ACTIVE Отчет полностью создан и готов к запросу.
FAILED Отчет не был создан.

Методы

create

 Инициирует создание задачи отчета.

get

 Получает метаданные отчета о конкретной задаче отчета.

list

 Перечисляет все задачи отчета для недвижимости.

query

 Получает содержание задачи отчета.