CohortSpec

同類群組報表的同類群組規格。

同類群組報表會為同類群組建立使用者留存時間序列。舉例來說，您可以選取 9 月第一週招攬到的使用者同類群組，並在接下來六週內追蹤該同類群組。在 cohort 物件中指定要選取 9 月第一週同類群組中招攬到的使用者。在 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 不支援此功能。