CohortSpec

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

同类群组报告会为同类群组创建用户留存率时间序列。例如，您可以选择在 9 月第一周获取的用户同类群组，并在接下来的 6 周内关注该同类群组。在 cohort 对象中指定在 9 月同类群组的第 1 周获取的用户。在 cohortsRange 对象中指定该同类群组后接下来的六周。

如需查看示例，请参阅同类群组报告示例。

报告响应可以显示每周时间序列，其中您的应用在 3 周后保留了该同类群组的 60%，在 6 周后保留了该同类群组的 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中不支持。