Class: Google::Apis::DfareportingV2_1::DimensionValueRequest

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

Overview

Represents a DimensionValuesRequest.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ DimensionValueRequest

Returns a new instance of DimensionValueRequest.


4275
4276
4277
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4275

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)

4251
4252
4253
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4251

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)

4257
4258
4259
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4257

def end_date
  @end_date
end

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

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


4262
4263
4264
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4262

def filters
  @filters
end

#kindString

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

Returns:

  • (String)

4267
4268
4269
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4267

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)

4273
4274
4275
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4273

def start_date
  @start_date
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


4280
4281
4282
4283
4284
4285
4286
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 4280

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