CohortSpec

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

同类群组报告会为同类群组创建用户留存率时间序列。例如，您可以选择 9 月第一周赢得的用户同类群组，并在接下来的 6 周内跟踪该同类群组。在 cohort 对象中指定了要选择 9 月第一周获取的用户的同类群组。在 cohortsRange 对象中指定了接下来 6 周内该同类群组的跟踪情况。

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

报告响应可能会显示每周的时间序列，例如，您的应用在三周后留住了该同类群组的 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_ 开头。如果未设置，同类群组将按从 0 开始的编号 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 为 1 周（从星期日开始到星期六结束），并且请求包含 cohortNthWeek，则通常使用此方法。
MONTHLY 按月粒度。如果同类群组的 dateRange 为一个月，并且请求包含 cohortNthMonth，则通常使用此方法。

CohortReportSettings

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

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

boolean

如果为 true，则从首次接触日期到结束日期累计结果。在 RunReportRequest 中不受支持。