Class: Google::Apis::DfareportingV2_3::DimensionValueRequest

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

Overview

Represents a DimensionValuesRequest.

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

Returns a new instance of DimensionValueRequest.


4327
4328
4329
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 4327

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

Instance Attribute Details

#dimension_nameString

The name of the dimension for which values should be requested. Corresponds to the JSON property dimensionName

Returns:

  • (String)

4303
4304
4305
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 4303

def dimension_name
  @dimension_name
end

#end_dateDate

The end date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". Corresponds to the JSON property endDate

Returns:

  • (Date)

4309
4310
4311
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 4309

def end_date
  @end_date
end

#filtersArray<Google::Apis::DfareportingV2_3::DimensionFilter>

The list of filters by which to filter values. The filters are ANDed. Corresponds to the JSON property filters


4314
4315
4316
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 4314

def filters
  @filters
end

#kindString

The kind of request this is, in this case dfareporting#dimensionValueRequest. Corresponds to the JSON property kind

Returns:

  • (String)

4319
4320
4321
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 4319

def kind
  @kind
end

#start_dateDate

The start date of the date range for which to retrieve dimension values. A string of the format "yyyy-MM-dd". Corresponds to the JSON property startDate

Returns:

  • (Date)

4325
4326
4327
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 4325

def start_date
  @start_date
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4332
4333
4334
4335
4336
4337
4338
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 4332

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