CohortSpec

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

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

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

レポートの回答では、アプリがこのコホートの 60% を 3 週間後に、このコホートの 25% が 6 週間後に保持しているという週単位の時系列を表示できます。この 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 か月にアライメントできます。

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

CohortReportSettings

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

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

boolean

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