CohortSpec

Спецификация когорт для отчета о когортах.

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

Примеры см. в разделе «Примеры когортных отчетов» .

Ответ на отчет может содержать еженедельный временной ряд, в котором, скажем, ваше приложение удержало 60 % этой группы через три недели и 25 % этой группы через шесть недель. Эти два процента могут быть рассчитаны по метрике cohortActiveUsers/cohortTotalUsers и будут представлять собой отдельные строки в отчете.

JSON-представление 
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Поля
cohorts[]

object ( Cohort )

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

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

cohortsRange

object ( CohortsRange )

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

cohortReportSettings

object ( CohortReportSettings )

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

когорта

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

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

string

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

dimension

string

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

dateRange

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 для расширенного диапазона дат отчетности для когортного отчета.

startOffset

integer

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

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

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

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

endOffset

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 .