CohortSpec

同类群组报告的同类群组规范。

同类群组报告会为同类群组的用户留存率创建时间序列。例如,您可以选择在 9 月份的第一周获取的用户同类群组,然后在接下来的 6 周内关注该同类群组。cohort 对象中指定了在 9 月第 1 周获取的用户同类群组。接下来六周的同类群组后即在 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_0cohort_1 等命名。

dimension

string

同类群组使用的维度。必需,并且仅支持 firstSessionDate

dateRange

object (DateRange)

同类群组选择首次联系日期介于 dateRange 中定义的开始日期和结束日期之间的用户。此dateRange未指定同类群组报告中显示的事件数据的完整日期范围。在同类群组报告中,此dateRange会按cohortsRange中的粒度和偏移量进行扩展;同类群组报告中会显示针对扩展报告日期范围的事件数据。

在同类群组请求中,此 dateRange 是必需的,并且 RunReportRequestRunPivotReportRequest 中的 dateRanges 必须未指定。

dateRange通常应与同类群组的粒度一致。如果 CohortsRange 使用“每日”粒度,则此 dateRange 可以是一天。如果 CohortsRange 使用每周粒度,则此 dateRange 可与周边界值(从星期日开始,到星期六结束)保持一致。如果 CohortsRange 使用每月粒度,则此 dateRange 可与月份对应,从第一天开始,在当月的最后一天结束。

CohortsRange

为同类群组报告配置延长的报告日期范围。指定跟进同类群组的偏移时长。

JSON 表示法
{
  "granularity": enum (Granularity),
  "startOffset": integer,
  "endOffset": integer
}
字段
granularity

enum (Granularity)

必需。用于解读同类群组报告的扩展报告日期范围内的 startOffsetendOffset 的粒度。

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 天。

细化程度

用于解读同类群组报告的扩展报告日期范围内的 startOffsetendOffset 的粒度。

枚举
GRANULARITY_UNSPECIFIED 不应指定。
DAILY 按天细分。通常如果同类群组的 dateRange 为一天,且请求包含 cohortNthDay,通常使用此参数。
WEEKLY 按周细分。通常在以下情况下使用:同类群组的 dateRange 持续一周(从星期日开始,到星期六结束),并且请求包含 cohortNthWeek
MONTHLY 按月细分。通常用于同类群组的 dateRange 持续一个月且请求包含 cohortNthMonth 的情况。

CohortReportSettings

同类群组报告的可选设置。

JSON 表示法
{
  "accumulate": boolean
}
字段
accumulate

boolean

如果为 true,则会累积从第一个接触日到结束日期的计算结果。在RunReportRequest不支持。