CohortSpec

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, você pode selecionar o coorte de usuários que foram adquiridos na primeira semana de setembro e acompanhar esse coorte nas próximas seis semanas. A seleção dos usuários adquiridos na coorte da primeira semana de setembro é especificada no objeto cohort. O acompanhamento dessa coorte nas próximas seis semanas é especificado no objeto cohortsRange.

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

A resposta do relatório pode mostrar uma série temporal semanal em que o app retém 60% dessa 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 coortes define apenas uma 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 acompanham coortes em um período 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, os 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 recebe 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 com data de primeiro contato entre a data de início e a data de término definidas em 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 no cohortsRange. Os dados de eventos para o período estendido 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 RunPivotReportRequest precisa ser não especificado.

Em geral, esse dateRange precisa estar alinhado com a granularidade do grupo. Se CohortsRange usar a granularidade diária, esse dateRange pode ser um único dia. Se CohortsRange usar granularidade semanal, dateRange poderá ser alinhado a um limite de semana, começando no domingo e terminando no sábado. Se o 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 relatórios para um relatório de coorte. Especifica uma duração de deslocamento para acompanhar as coortes.

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

enum (Granularity)

Obrigatório. A granularidade usada para interpretar o startOffset e o 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 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 de relatórios será startDate da coorte mais startOffset dias.

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

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

integer

Obrigatório. endOffset especifica a data de término do período estendido 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 de relatórios será endDate da coorte mais endOffset dias.

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

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

Granularidade

A granularidade usada para interpretar o startOffset e o endOffset para o período estendido de um relatório de coorte.

Enums
GRANULARITY_UNSPECIFIED Nunca deve ser especificado.
DAILY Granularidade diária. É comumente usado quando o dateRange do grupo é um único dia e a solicitação contém cohortNthDay.
WEEKLY Granularidade semanal. É usado com frequência quando o dateRange do grupo tem uma semana de duração (início no domingo e término no sábado) e a solicitação contém cohortNthWeek.
MONTHLY Granularidade mensal. É comumente usado quando a dateRange da coorte tem a duração de um mês e a solicitação contém 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 dia do primeiro contato até o dia final. Não é compatível com RunReportRequest.