CohortSpec

A especificação de coortes para um relatório de coorte.

Os relatórios de coorte criam uma série temporal de retenção de usuários para a coorte. Por exemplo, é possível selecionar a coorte de usuários adquiridos na primeira semana de setembro e seguir essa coorte pelas próximas seis semanas. A seleção dos usuários adquiridos na primeira semana da coorte de setembro é especificada no objeto cohort. A coorte das próximas seis semanas é especificada no objeto cohortsRange.

Para exemplos, consulte Exemplos de relatórios de coorte.

A resposta do relatório pode mostrar uma série temporal semanal em que o app reteve 60% da coorte após três semanas e 25% após seis semanas. Essas duas porcentagens podem ser calculadas pela métrica cohortActiveUsers/cohortTotalUsers e vão aparecer em linhas separadas no relatório.

Representação JSON
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Campos
cohorts[]

object (Cohort)

Define os critérios de seleção para agrupar usuários em coortes.

A maioria dos relatórios de coorte define apenas uma única coorte. Se várias coortes forem especificadas, cada uma delas poderá ser reconhecida no relatório pelo nome.

cohortsRange

object (CohortsRange)

Os relatórios de coorte seguem as coortes durante um período de relatório estendido. Esse intervalo especifica uma duração de deslocamento para acompanhar as coortes.

cohortReportSettings

object (CohortReportSettings)

Configurações opcionais para um relatório de coorte.

Coorte

Define um critério de seleção de coorte. Um coorte é um grupo de usuários que compartilham uma característica comum. Por exemplo, usuários com o mesmo firstSessionDate pertencem à mesma coorte.

Representação JSON
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
Campos
name

string

Atribui um nome à coorte. A dimensão cohort é avaliada para esse nome em uma resposta de relatório. Se definido, não pode começar com cohort_ ou RESERVED_. Se não for definida, as coortes serão nomeadas pelo índice baseado em zero cohort_0, cohort_1 etc.

dimension

string

Dimensão usada pela coorte. Obrigatório e compatível apenas com firstSessionDate.

dateRange

object (DateRange)

A coorte seleciona usuários que tiveram a data do primeiro contato entre as datas de início e término definidas no dateRange. Esse dateRange não especifica o período completo dos dados de eventos presentes em um relatório de coorte. Em um relatório de coorte, esse dateRange é estendido pela granularidade e pelo deslocamento presentes na cohortsRange. os dados de eventos para o período estendido de relatório estão presentes em um relatório de coorte.

Em uma solicitação de coorte, a dateRange é obrigatória, e o dateRanges na RunReportRequest ou na RunPivotReportRequest não pode ser especificado.

Esse dateRange geralmente precisa estar alinhado à granularidade da coorte. Se CohortsRange usar granularidade diária, esse dateRange poderá ser um único dia. Se CohortsRange usar granularidade semanal, esse dateRange poderá ser alinhado a um limite de semana, começando no domingo e terminando no sábado. Se CohortsRange usar granularidade mensal, esse dateRange poderá ser alinhado a um mês, começando no primeiro e terminando no último dia do mês.

CohortsRange

Configura o período estendido de um relatório de coorte. Especifica uma duração de deslocamento para seguir as coortes.

Representação JSON
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Campos
granularity

enum (Granularity)

Obrigatório. É a granularidade usada para interpretar startOffset e endOffset no período estendido de um relatório de coorte.

startOffset

integer

startOffset especifica a data de início do período estendido de um relatório de coorte. startOffset é normalmente definido como 0 para que os relatórios contenham dados da aquisição da coorte futura.

Se granularity for DAILY, o startDate do período estendido do relatório será startDate da coorte mais startOffset dias.

Se granularity for WEEKLY, o startDate do período estendido do relatório será startDate da coorte mais startOffset * 7 dias.

Se granularity for MONTHLY, o startDate do período estendido do relatório será startDate da coorte mais startOffset * 30 dias.

endOffset

integer

Obrigatório. endOffset especifica a data de término do período estendido de relatório para um relatório de coorte. endOffset pode ser qualquer número inteiro positivo, mas normalmente é definido como 5 a 10 para que os relatórios contenham dados da coorte para os próximos períodos de granularidade.

Se granularity for DAILY, o endDate do período estendido do relatório será endDate da coorte mais endOffset dias.

Se granularity for WEEKLY, o endDate do período estendido do relatório será endDate da coorte mais endOffset * 7 dias.

Se granularity for MONTHLY, o endDate do período estendido do relatório será endDate da coorte mais endOffset * 30 dias.

Granularidade

É a granularidade usada para interpretar startOffset e endOffset no período estendido de um relatório de coorte.

Enums
GRANULARITY_UNSPECIFIED Nunca deve ser especificado.
DAILY Granularidade diária. Usado normalmente se o dateRange da coorte for de um único dia e a solicitação contiver cohortNthDay.
WEEKLY Granularidade semanal. Usado com frequência se o dateRange da coorte tiver uma semana de duração (começando no domingo e terminando no sábado) e se a solicitação contiver cohortNthWeek.
MONTHLY Granularidade mensal. Usado normalmente se o dateRange da coorte tiver a duração de um mês e a solicitação contiver cohortNthMonth.

CohortReportSettings

Configurações opcionais de um relatório de coorte.

Representação JSON
{
  "accumulate": boolean
}
Campos
accumulate

boolean

Se verdadeiro, acumula o resultado do primeiro dia de contato até o dia de término. Indisponível em RunReportRequest.