Google Analytics Data V1alpha API - Class Google::Analytics::Data::V1alpha::Cohort (v0.8.3)

Reference documentation and code samples for the Google Analytics Data V1alpha API class Google::Analytics::Data::V1alpha::Cohort.

Defines a cohort selection criteria. A cohort is a group of users who share a common characteristic. For example, users with the same firstTouchDate belong to the same cohort.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#date_range

def date_range() -> ::Google::Analytics::Data::V1alpha::DateRange
Returns
  • (::Google::Analytics::Data::V1alpha::DateRange) — The cohort selects users whose first touch date is between start date and end date defined in the dateRange. This dateRange does not specify the full date range of event data that is present in a cohort report. In a cohort report, this dateRange is extended by the granularity and offset present in the cohortsRange; event data for the extended reporting date range is present in a cohort report.

    In a cohort request, this dateRange is required and the dateRanges in the RunReportRequest or RunPivotReportRequest must be unspecified.

    This dateRange should generally be aligned with the cohort's granularity. If CohortsRange uses daily granularity, this dateRange can be a single day. If CohortsRange uses weekly granularity, this dateRange can be aligned to a week boundary, starting at Sunday and ending Saturday. If CohortsRange uses monthly granularity, this dateRange can be aligned to a month, starting at the first and ending on the last day of the month.

#date_range=

def date_range=(value) -> ::Google::Analytics::Data::V1alpha::DateRange
Parameter
  • value (::Google::Analytics::Data::V1alpha::DateRange) — The cohort selects users whose first touch date is between start date and end date defined in the dateRange. This dateRange does not specify the full date range of event data that is present in a cohort report. In a cohort report, this dateRange is extended by the granularity and offset present in the cohortsRange; event data for the extended reporting date range is present in a cohort report.

    In a cohort request, this dateRange is required and the dateRanges in the RunReportRequest or RunPivotReportRequest must be unspecified.

    This dateRange should generally be aligned with the cohort's granularity. If CohortsRange uses daily granularity, this dateRange can be a single day. If CohortsRange uses weekly granularity, this dateRange can be aligned to a week boundary, starting at Sunday and ending Saturday. If CohortsRange uses monthly granularity, this dateRange can be aligned to a month, starting at the first and ending on the last day of the month.

Returns
  • (::Google::Analytics::Data::V1alpha::DateRange) — The cohort selects users whose first touch date is between start date and end date defined in the dateRange. This dateRange does not specify the full date range of event data that is present in a cohort report. In a cohort report, this dateRange is extended by the granularity and offset present in the cohortsRange; event data for the extended reporting date range is present in a cohort report.

    In a cohort request, this dateRange is required and the dateRanges in the RunReportRequest or RunPivotReportRequest must be unspecified.

    This dateRange should generally be aligned with the cohort's granularity. If CohortsRange uses daily granularity, this dateRange can be a single day. If CohortsRange uses weekly granularity, this dateRange can be aligned to a week boundary, starting at Sunday and ending Saturday. If CohortsRange uses monthly granularity, this dateRange can be aligned to a month, starting at the first and ending on the last day of the month.

#dimension

def dimension() -> ::String
Returns
  • (::String) — Dimension used by the cohort. Required and only supports firstTouchDate.

#dimension=

def dimension=(value) -> ::String
Parameter
  • value (::String) — Dimension used by the cohort. Required and only supports firstTouchDate.
Returns
  • (::String) — Dimension used by the cohort. Required and only supports firstTouchDate.

#name

def name() -> ::String
Returns
  • (::String) — Assigns a name to this cohort. The dimension cohort is valued to this name in a report response. If set, cannot begin with cohort_ or RESERVED_. If not set, cohorts are named by their zero based index cohort_0, cohort_1, etc.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — Assigns a name to this cohort. The dimension cohort is valued to this name in a report response. If set, cannot begin with cohort_ or RESERVED_. If not set, cohorts are named by their zero based index cohort_0, cohort_1, etc.
Returns
  • (::String) — Assigns a name to this cohort. The dimension cohort is valued to this name in a report response. If set, cannot begin with cohort_ or RESERVED_. If not set, cohorts are named by their zero based index cohort_0, cohort_1, etc.