Class: Google::Apis::AnalyticsreportingV4::CohortGroup

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

Overview

Defines a cohort group. For example: "cohortGroup": "cohorts": [ "name": "cohort 1", "type": "FIRST_VISIT_DATE", "dateRange": "startDate": "2015-08-01", "endDate": "2015-08-01" , "name": "cohort 2" "type": "FIRST_VISIT_DATE" "dateRange": "startDate": "2015-07-01", "endDate": "2015-07-01" ]

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CohortGroup

Returns a new instance of CohortGroup



116
117
118
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 116

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

Instance Attribute Details

#cohortsArray<Google::Apis::AnalyticsreportingV4::Cohort>

The definition for the cohort. Corresponds to the JSON property cohorts



82
83
84
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 82

def cohorts
  @cohorts
end

#lifetime_valueBoolean Also known as: lifetime_value?

Enable Life Time Value (LTV). LTV measures lifetime value for users acquired through different channels. Please see: Cohort Analysis and Lifetime Value If the value of lifetimeValue is false:

  • The metric values are similar to the values in the web interface cohort report.
  • The cohort definition date ranges must be aligned to the calendar week and month. i.e. while requesting ga:cohortNthWeek the startDate in the cohort definition should be a Sunday and the endDate should be the following Saturday, and for ga:cohortNthMonth, the startDate should be the 1st of the month and endDate should be the last day of the month. When the lifetimeValue is true:
  • The metric values will correspond to the values in the web interface LifeTime value report.
  • The Lifetime Value report shows you how user value (Revenue) and engagement (Appviews, Goal Completions, Sessions, and Session Duration) grow during the 90 days after a user is acquired.
  • The metrics are calculated as a cumulative average per user per the time increment.
  • The cohort definition date ranges need not be aligned to the calendar week and month boundaries.
  • The viewId must be an app view ID Corresponds to the JSON property lifetimeValue

Returns:

  • (Boolean)


113
114
115
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 113

def lifetime_value
  @lifetime_value
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



121
122
123
124
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 121

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