Class: Google::Apis::DfareportingV2_8::Report::ReachCriteria

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

Overview

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

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

Returns a new instance of ReachCriteria



10205
10206
10207
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10205

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

Instance Attribute Details

#activities ⇒ Google::Apis::DfareportingV2_8::Activities

Represents an activity group. Corresponds to the JSON property activities

Returns:



10163
10164
10165
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10163

def activities
  @activities
end

#custom_rich_media_events ⇒ Google::Apis::DfareportingV2_8::CustomRichMediaEvents

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

Returns:



10168
10169
10170
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10168

def custom_rich_media_events
  @custom_rich_media_events
end

#date_range ⇒ Google::Apis::DfareportingV2_8::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



10173
10174
10175
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10173

def date_range
  @date_range
end

#dimension_filters ⇒ Array<Google::Apis::DfareportingV2_8::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:



10180
10181
10182
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10180

def dimension_filters
  @dimension_filters
end

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

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

Returns:



10185
10186
10187
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10185

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 42 days. Corresponds to the JSON property enableAllDimensionCombinations

Returns:

  • (Boolean) 


10192
10193
10194
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10192

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


10198
10199
10200
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10198

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


10203
10204
10205
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10203

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10210

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