CohortSpec

Spécification des cohortes pour un rapport sur les cohortes.

Les rapports sur les cohortes créent une série temporelle de fidélisation des utilisateurs pour la cohorte. Par exemple, vous pouvez sélectionner la cohorte d'utilisateurs qui ont été acquis au cours de la première semaine de septembre et suivre cette cohorte pendant les six semaines suivantes. La sélection des utilisateurs acquis au cours de la première semaine de cohorte de septembre est spécifiée dans l'objet cohort. Cette dernière est indiquée dans l'objet cohortsRange pour les six prochaines semaines.

Pour obtenir des exemples, reportez-vous à la section Exemples de rapports sur les cohortes.

La réponse au rapport peut indiquer une série temporelle hebdomadaire dans laquelle votre application a retenu 60% de cette cohorte après trois semaines et 25% de cette cohorte après six semaines. Ces deux pourcentages peuvent être calculés à l'aide de la métrique cohortActiveUsers/cohortTotalUsers et constitueront des lignes distinctes dans le rapport.

Représentation JSON
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
Champs
cohorts[]

object (Cohort)

Définit les critères de sélection pour regrouper les utilisateurs en cohortes.

La plupart des rapports sur les cohortes ne définissent qu'une seule cohorte. Si plusieurs cohortes sont spécifiées, chacune d'elles peut être reconnue dans le rapport par son nom.

cohortsRange

object (CohortsRange)

Les rapports sur les cohortes suivent les cohortes sur une période étendue. Cette plage spécifie une durée de décalage sur laquelle suivre les cohortes.

cohortReportSettings

object (CohortReportSettings)

Paramètres facultatifs d'un rapport sur les cohortes.

Cohorte

Définit un critère de sélection de cohorte. Une cohorte est un groupe d'utilisateurs qui partagent une caractéristique commune. Par exemple, les utilisateurs ayant le même firstSessionDate appartiennent à la même cohorte.

Représentation JSON
{
  "name": string,
  "dimension": string,
  "dateRange": {
    object (DateRange)
  }
}
Champs
name

string

Attribue un nom à cette cohorte. La dimension "cohort" prend ce nom sous ce nom dans une réponse de rapport. S'il est défini, il ne peut pas commencer par cohort_ ni par RESERVED_. Si cette règle n'est pas configurée, les cohortes sont nommées d'après leur index basé sur zéro (cohort_0, cohort_1, etc.).

dimension

string

Dimension utilisée par la cohorte. Obligatoire et n'est compatible qu'avec firstSessionDate.

dateRange

object (DateRange)

La cohorte sélectionne les utilisateurs dont la première date de contact est comprise entre la date de début et la date de fin définies dans les dateRange. Cet élément dateRange ne spécifie pas la plage de dates complète des données d'événement qui figurent dans un rapport sur les cohortes. Dans un rapport sur les cohortes, ce dateRange est étendu par la précision et le décalage présents dans cohortsRange. les données d'événement correspondant à la période étendue sont présentes dans le rapport sur les cohortes.

Dans une demande de cohorte, cet élément dateRange est obligatoire, et l'élément dateRanges de l'élément RunReportRequest ou RunPivotReportRequest ne doit pas être spécifié.

Ce dateRange doit généralement être aligné sur la précision de la cohorte. Si CohortsRange utilise une précision quotidienne, cette dateRange ne peut correspondre qu'à un seul jour. Si CohortsRange utilise une précision hebdomadaire, cette dateRange peut être alignée sur une limite de semaine, du dimanche au samedi. Si CohortsRange utilise une précision mensuelle, cette dateRange peut être alignée sur un mois, du premier au dernier jour du mois.

CohortsRange

Configure la période étendue d'un rapport sur une cohorte. Spécifie une durée de décalage pour le suivi des cohortes.

Représentation JSON
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
Champs
granularity

enum (Granularity)

Obligatoire. Niveau de précision utilisé pour interpréter les valeurs startOffset et endOffset pour la période étendue d'un rapport sur une cohorte.

startOffset

integer

startOffset indique la date de début de la période étendue d'un rapport sur une cohorte. La valeur startOffset est généralement définie sur 0 afin que les rapports contiennent les données issues de l'acquisition de la cohorte.

Si granularity correspond à DAILY, la valeur startDate de la plage de dates étendue du rapport correspond à startDate de la cohorte plus startOffset jours.

Si granularity correspond à WEEKLY, la valeur startDate de la plage de dates étendue du rapport correspond à startDate de la cohorte plus startOffset * 7 jours.

Si granularity correspond à MONTHLY, la valeur startDate de la plage de dates étendue du rapport correspond à startDate de la cohorte plus startOffset * 30 jours.

endOffset

integer

Obligatoire. endOffset indique la date de fin de la période étendue d'un rapport sur une cohorte. endOffset peut correspondre à n'importe quel entier positif, mais sa valeur est généralement comprise entre 5 et 10 afin que les rapports contiennent des données sur la cohorte pour les périodes de précision suivantes.

Si granularity correspond à DAILY, la valeur endDate de la plage de dates étendue du rapport correspond à endDate de la cohorte plus endOffset jours.

Si granularity correspond à WEEKLY, la valeur endDate de la plage de dates étendue du rapport correspond à endDate de la cohorte plus endOffset * 7 jours.

Si granularity correspond à MONTHLY, la valeur endDate de la plage de dates étendue du rapport correspond à endDate de la cohorte plus endOffset * 30 jours.

Précision

Niveau de précision utilisé pour interpréter les valeurs startOffset et endOffset pour la période étendue d'un rapport sur une cohorte.

Enums
GRANULARITY_UNSPECIFIED Ne doit jamais être spécifié.
DAILY Précision quotidienne. Ce paramètre est fréquemment utilisé si le dateRange de la cohorte correspond à un seul jour et que la requête contient cohortNthDay.
WEEKLY Précision hebdomadaire. Il est généralement utilisé si le dateRange de la cohorte dure une semaine (du dimanche au samedi) et que la requête contient cohortNthWeek.
MONTHLY Précision mensuelle. Ce paramètre est fréquemment utilisé si le dateRange de la cohorte dure un mois et que la requête contient cohortNthMonth.

CohortReportSettings

Paramètres facultatifs d'un rapport sur les cohortes.

Représentation JSON
{
  "accumulate": boolean
}
Champs
accumulate

boolean

Si la valeur est "true", le résultat s'accumule entre le premier jour de contact et le jour de la fin. Non disponible dans ce pays : RunReportRequest.