CohortSpec

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

「同類群組」報表會為同類群組建立一系列使用者留存率。舉例來說，您可以選取 9 月第一週招攬到的使用者同類群組，並追蹤接下來六週的同類群組。選取 9 月同類群組第一週開發的使用者可在 cohort 物件中指定。接下來六週之後的同類群組會在 cohortsRange 物件中指定。

如需範例，請參閱同類群組報表範例。

報告回覆可以顯示每週的時間序列，指出您的應用程式在三週後留存了 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 不支援。