Class: Google::Apis::DfareportingV2_1::Report::ReachCriteria

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

The report criteria for a report of type "REACH".

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ReachCriteria

Returns a new instance of ReachCriteria



9379
9380
9381
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9379

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

Instance Attribute Details

#activities ⇒ Google::Apis::DfareportingV2_1::Activities

Represents an activity group. Corresponds to the JSON property activities

Returns:



9337
9338
9339
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9337

def activities
  @activities
end

#custom_rich_media_events ⇒ Google::Apis::DfareportingV2_1::CustomRichMediaEvents

Represents a Custom Rich Media Events group. Corresponds to the JSON property customRichMediaEvents

Returns:



9342
9343
9344
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9342

def custom_rich_media_events
  @custom_rich_media_events
end

#date_range ⇒ Google::Apis::DfareportingV2_1::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



9347
9348
9349
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9347

def date_range
  @date_range
end

#dimension_filters ⇒ Array<Google::Apis::DfareportingV2_1::DimensionValue>

The list of filters on which dimensions are filtered. Filters for different dimensions are ANDed, filters for the same dimension are grouped together and ORed. Corresponds to the JSON property dimensionFilters

Returns:



9354
9355
9356
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9354

def dimension_filters
  @dimension_filters
end

#dimensions ⇒ Array<Google::Apis::DfareportingV2_1::SortedDimension>

The list of dimensions the report should include. Corresponds to the JSON property dimensions

Returns:



9359
9360
9361
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9359

def dimensions
  @dimensions
end

#enable_all_dimension_combinations ⇒ Boolean Also known as: enable_all_dimension_combinations?

Whether to enable all reach dimension combinations in the report. Defaults to false. If enabled, the date range of the report should be within the last three months. Corresponds to the JSON property enableAllDimensionCombinations

Returns:

  • (Boolean) 


9366
9367
9368
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9366

def enable_all_dimension_combinations
  @enable_all_dimension_combinations
end

#metric_names ⇒ Array<String>

The list of names of metrics the report should include. Corresponds to the JSON property metricNames

Returns:

  • (Array<String>) 


9372
9373
9374
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9372

def metric_names
  @metric_names
end

#reach_by_frequency_metric_names ⇒ Array<String>

The list of names of Reach By Frequency metrics the report should include. Corresponds to the JSON property reachByFrequencyMetricNames

Returns:

  • (Array<String>) 


9377
9378
9379
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9377

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
 
# File 'generated/google/apis/dfareporting_v2_1/classes.rb', line 9384

def update!(**args)
  @activities = args[:activities] unless args[:activities].nil?
  @custom_rich_media_events = args[:custom_rich_media_events] unless args[:custom_rich_media_events].nil?
  @date_range = args[:date_range] unless args[:date_range].nil?
  @dimension_filters = args[:dimension_filters] unless args[:dimension_filters].nil?
  @dimensions = args[:dimensions] unless args[:dimensions].nil?
  @enable_all_dimension_combinations = args[:enable_all_dimension_combinations] unless args[:enable_all_dimension_combinations].nil?
  @metric_names = args[:metric_names] unless args[:metric_names].nil?
  @reach_by_frequency_metric_names = args[:reach_by_frequency_metric_names] unless args[:reach_by_frequency_metric_names].nil?
end