Class: Google::Apis::AnalyticsdataV1alpha::DateRange

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

A contiguous set of days: startDate, startDate + 1, ..., endDate. Requests are allowed up to 4 date ranges.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DateRange

Returns a new instance of DateRange.



370
371
372
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 370

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

Instance Attribute Details

#end_date ⇒ String

The inclusive end date for the query in the format YYYY-MM-DD. Cannot be before start_date. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the property's reporting time zone. Corresponds to the JSON property endDate

Returns:

  • (String) 


352
353
354
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 352

def end_date
  @end_date
end

#name ⇒ String

Assigns a name to this date range. The dimension dateRange is valued to this name in a report response. If set, cannot begin with date_range_ or RESERVED_. If not set, date ranges are named by their zero based index in the request: date_range_0, date_range_1, etc. Corresponds to the JSON property name

Returns:

  • (String) 


360
361
362
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 360

def name
  @name
end

#start_date ⇒ String

The inclusive start date for the query in the format YYYY-MM-DD. Cannot be after end_date. The format NdaysAgo, yesterday, or today is also accepted, and in that case, the date is inferred based on the property's reporting time zone. Corresponds to the JSON property startDate

Returns:

  • (String) 


368
369
370
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 368

def start_date
  @start_date
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



375
376
377
378
379
 
# File 'generated/google/apis/analyticsdata_v1alpha/classes.rb', line 375

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