Class: Google::Apis::AnalyticsdataV1alpha::CohortsRange

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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CohortsRange

Returns a new instance of CohortsRange.



299
300
301
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 299

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

Instance Attribute Details

#end_offset ⇒ Fixnum

Required. endOffset specifies the end date of the extended reporting date range for a cohort report. endOffset can be any positive integer but is commonly set to 5 to 10 so that reports contain data on the cohort for the next several granularity time periods. If granularity is DAILY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset days. If granularity is WEEKLY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset * 7 days. If granularity is MONTHLY, the endDate of the extended reporting date range is endDate of the cohort plus endOffset * 30 days. Corresponds to the JSON property endOffset

Returns:

  • (Fixnum) 


278
279
280
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 278

def end_offset
  @end_offset
end

#granularity ⇒ String

Required. The granularity used to interpret the startOffset and endOffset for the extended reporting date range for a cohort report. Corresponds to the JSON property granularity

Returns:

  • (String) 


284
285
286
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 284

def granularity
  @granularity
end

#start_offset ⇒ Fixnum

startOffset specifies the start date of the extended reporting date range for a cohort report. startOffset is commonly set to 0 so that reports contain data from the acquisition of the cohort forward. If granularity is DAILY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset days. If granularity is WEEKLY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset * 7 days. If granularity is MONTHLY, the startDate of the extended reporting date range is startDate of the cohort plus startOffset * 30 days. Corresponds to the JSON property startOffset

Returns:

  • (Fixnum) 


297
298
299
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 297

def start_offset
  @start_offset
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



304
305
306
307
308
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 304

def update!(**args)
  @end_offset = args[:end_offset] if args.key?(:end_offset)
  @granularity = args[:granularity] if args.key?(:granularity)
  @start_offset = args[:start_offset] if args.key?(:start_offset)
end