Class: Google::Apis::AnalyticsreportingV4::Cohort

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. A cohort is a group of users who share a common characteristic. For example, all users with the same acquisition date belong to the same cohort.

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) ⇒ Cohort

Returns a new instance of Cohort.


181
182
183
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 181

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

Instance Attribute Details

#date_rangeGoogle::Apis::AnalyticsreportingV4::DateRange

A contiguous set of days: startDate, startDate + 1 day, ..., endDate. The start and end dates are specified in ISO8601 date format YYYY-MM-DD. Corresponds to the JSON property dateRange


166
167
168
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 166

def date_range
  @date_range
end

#nameString

A unique name for the cohort. If not defined name will be auto-generated with values cohort_[1234...]. Corresponds to the JSON property name

Returns:

  • (String)

172
173
174
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 172

def name
  @name
end

#typeString

Type of the cohort. The only supported type as of now is FIRST_VISIT_DATE. If this field is unspecified the cohort is treated as FIRST_VISIT_DATE type cohort. Corresponds to the JSON property type

Returns:

  • (String)

179
180
181
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 179

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


186
187
188
189
190
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 186

def update!(**args)
  @date_range = args[:date_range] if args.key?(:date_range)
  @name = args[:name] if args.key?(:name)
  @type = args[:type] if args.key?(:type)
end