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



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

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:



10161
10162
10163
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10161

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:



10166
10167
10168
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10166

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:



10171
10172
10173
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10171

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:



10178
10179
10180
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10178

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:



10183
10184
10185
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10183

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) 


10190
10191
10192
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10190

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


10196
10197
10198
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10196

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


10201
10202
10203
 
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10201

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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