CohortSpec

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

同类群组报告会为同类群组创建一个用户留存率时间序列。例如，您可以选择在 9 月第 1 周获取的用户同类群组，并在接下来的 6 周内关注该同类群组。选择在 9 月同类群组中的第一周获取的用户是在 cohort 对象中指定的。在 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_0、cohort_1 等命名。
dimension

string

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

object (DateRange)

该同类群组选择首次触摸日期介于 dateRange 中定义的开始日期和结束日期之间的用户。此 dateRange 没有指定同类群组报告中显示的事件数据的完整日期范围。在同类群组报告中，此 dateRange 会按 cohortsRange 中的粒度和偏移进行扩展；扩展报告日期范围内的事件数据会显示在同类群组报告中。

在同类群组请求中，此 dateRange 是必需的，RunReportRequest 或 RunPivotReportRequest 中的 dateRanges 必须指定。

此 dateRange 通常应与同类群组的粒度一致。如果 CohortsRange 使用每日粒度，则此 dateRange 可以是单日。如果 CohortsRange 使用每周粒度，则此 dateRange 可以匹配周边界（从星期日开始，到星期六结束）。如果 CohortsRange 采用每月粒度，则此 dateRange 可以与月份对齐，从第一天开始，一直到当月的最后一天。

CohortsRange

配置同类群组报告的扩展报告日期范围。指定同类群组采用的偏移时长。

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

enum (Granularity)

必需。用于解读同类群组报告的扩展报告日期范围内的 startOffset 和 endOffset 的粒度。
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 天。

细化程度

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

枚举
GRANULARITY_UNSPECIFIED 绝不应指定。
DAILY 按天细分。通常用于同类群组的 dateRange 为一天且请求包含 cohortNthDay 的情况。
WEEKLY 按周朗读。通常用于同类群组的 dateRange 为一周（从星期日开始，到星期六结束）并且请求包含 cohortNthWeek。
MONTHLY 按月细分。通常用于同类群组的 dateRange 为一个月，请求中包含 cohortNthMonth 的情况。

CohortReportSettings

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

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

boolean

如果为 true，则将结果从第一次接触到当天结束。RunReportRequest不支持此功能。