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. Por exemplo, é possível selecionar a coorte de usuários que foram adquiridos na primeira semana de setembro e acompanhar 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. O acompanhamento dessa coorte pelas próximas seis semanas é especificado no objeto cohortsRange.

Para ver exemplos, consulte Exemplos de Relatório de coorte.

A resposta do relatório pode mostrar uma série temporal semanal em que digamos que seu 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 serão 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 define somente 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 coortes para um período estendido de relatório. Esse intervalo especifica uma duração de deslocamento para seguir as coortes.

cohortReportSettings

object (CohortReportSettings)

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

Coorte

Define os critérios de seleção de uma 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 a essa coorte. A dimensão cohort é avaliada com esse nome em uma resposta de relatório. Se definido, não pode começar com cohort_ ou RESERVED_. Se não for definido, 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 o primeiro contato entre a data de início e de 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 deslocamento presentes em cohortsRange. Os dados de evento do período estendido do relatório estão presentes em um relatório de coorte.

Em uma solicitação de coorte, esse dateRange é obrigatório, e o dateRanges no RunReportRequest ou no RunPivotReportRequest não pode ser especificado.

Em geral, esse dateRange precisa estar alinhado à granularidade da coorte. Se CohortsRange usar a granularidade diária, essa 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 para o período estendido de um relatório de coorte.

startOffset

integer

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

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 do relatório de um relatório de coorte. endOffset pode ser qualquer número inteiro positivo, mas geralmente é definido como 5 a 10 para que os relatórios contenham dados sobre a 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 para o período estendido de um relatório de coorte.

Enums
GRANULARITY_UNSPECIFIED Nunca deve ser especificado.
DAILY Granularidade diária. Geralmente usado se o dateRange da coorte for um único dia e a solicitação contiver cohortNthDay.
WEEKLY Granularidade semanal. Usado normalmente se a dateRange da coorte tiver uma semana de duração (começando no domingo e terminando no sábado) e a solicitação contém cohortNthWeek.
MONTHLY Granularidade mensal. Usado normalmente se o dateRange da coorte tiver um mês de duração 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.