CohortSpec

コホート レポートのコホートの仕様。

コホート レポートでは、コホートのユーザー維持率の時系列が作成されます。たとえば、9 月の第 1 週に獲得したユーザーのコホートを選択し、そのコホートを次の 6 週間追跡できます。9 月の第 1 週に獲得したユーザーを選択するコホートは、cohort オブジェクトで指定します。その後の 6 週間のコホートについては、cohortsRange オブジェクトで指定します。

例については、コホート レポートの例をご覧ください。

レポートのレスポンスには、アプリがこのコホートの 60% を 3 週間後に維持し、6 週間後に 25% を維持したという、週単位の時系列が表示されます。これらの 2 つの割合は指標 cohortActiveUsers/cohortTotalUsers で計算でき、レポートでは別々の行に表示されます。

JSON 表現 
{
  "cohorts": [
    {
      object (Cohort)
    }
  ],
  "cohortsRange": {
    object (CohortsRange)
  },
  "cohortReportSettings": {
    object (CohortReportSettings)
  }
}
フィールド
cohorts[]

object (Cohort)

ユーザーをコホートにグループ化するための選択条件を定義します。

ほとんどのコホート レポートでは、1 つのコホートのみ定義されます。複数のコホートを指定した場合、各コホートはレポート内で名前で識別できます。
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 は 1 日単位にできます。CohortsRange で週単位の粒度を使用している場合、この dateRange は日曜日から土曜日までの週の境界に合わせて調整できます。CohortsRange で月単位の粒度を使用している場合、この dateRange は 1 日から最終日までの 1 か月単位に調整できます。

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 1 日単位の粒度。コホートの dateRange が 1 日で、リクエストに cohortNthDay が含まれている場合によく使用されます。
WEEKLY 週単位の粒度。コホートの dateRange が 1 週間（日曜日から土曜日まで）で、リクエストに cohortNthWeek が含まれている場合によく使用されます。
MONTHLY 月単位の粒度。コホートの dateRange が 1 か月で、リクエストに cohortNthMonth が含まれている場合によく使用されます。

CohortReportSettings

コホート レポートのオプション設定。

JSON 表現 
{
  "accumulate": boolean
}
フィールド
accumulate

boolean

true の場合、最初の接触日から終了日までの結果が集計されます。RunReportRequest ではサポートされていません。