Class: Google::Apis::AnalyticsdataV1beta::CohortSpec

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

Overview

The specification of cohorts for a cohort report. Cohort reports 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. For examples, see Cohort Report Examples. 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.



332
333
334
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 332

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

Instance Attribute Details

#cohort_report_settings ⇒ Google::Apis::AnalyticsdataV1beta::CohortReportSettings

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

Returns:



317
318
319
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 317

def cohort_report_settings
  @cohort_report_settings
end

#cohorts ⇒ Array<Google::Apis::AnalyticsdataV1beta::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:



324
325
326
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 324

def cohorts
  @cohorts
end

#cohorts_range ⇒ Google::Apis::AnalyticsdataV1beta::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:



330
331
332
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 330

def cohorts_range
  @cohorts_range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



337
338
339
340
341
 
# File 'lib/google/apis/analyticsdata_v1beta/classes.rb', line 337

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