Class: Google::Apis::AnalyticsdataV1alpha::CohortSpec

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/analyticsdata_v1alpha/classes.rb,
generated/google/apis/analyticsdata_v1alpha/representations.rb,
generated/google/apis/analyticsdata_v1alpha/representations.rb

Overview

Specification of cohorts for a cohort report. Cohort reports can be used for example to create a time series of user retention for the cohort. For example, you could select the cohort of users that were acquired in the first week of September and follow that cohort for the next six weeks. Selecting the users acquired in the first week of September cohort is specified in the cohort object. Following that cohort for the next six weeks is specified in the cohortsRange object. The report response could show a weekly time series where say your app has retained 60% of this cohort after three weeks and 25% of this cohort after six weeks. These two percentages can be calculated by the metric cohortActiveUsers/cohortTotalUsers and will be separate rows in the report.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CohortSpec

Returns a new instance of CohortSpec.



250
251
252
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 250

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#cohort_report_settings ⇒ Google::Apis::AnalyticsdataV1alpha::CohortReportSettings

Optional settings of a cohort report. Corresponds to the JSON property cohortReportSettings

Returns:



235
236
237
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 235

def cohort_report_settings
  @cohort_report_settings
end

#cohorts ⇒ Array<Google::Apis::AnalyticsdataV1alpha::Cohort>

Defines the selection criteria to group users into cohorts. Most cohort reports define only a single cohort. If multiple cohorts are specified, each cohort can be recognized in the report by their name. Corresponds to the JSON property cohorts

Returns:



242
243
244
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 242

def cohorts
  @cohorts
end

#cohorts_range ⇒ Google::Apis::AnalyticsdataV1alpha::CohortsRange

Configures the extended reporting date range for a cohort report. Specifies an offset duration to follow the cohorts over. Corresponds to the JSON property cohortsRange

Returns:



248
249
250
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 248

def cohorts_range
  @cohorts_range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



255
256
257
258
259
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 255

def update!(**args)
  @cohort_report_settings = args[:cohort_report_settings] if args.key?(:cohort_report_settings)
  @cohorts = args[:cohorts] if args.key?(:cohorts)
  @cohorts_range = args[:cohorts_range] if args.key?(:cohorts_range)
end