Class: Google::Apis::DfareportingV3_3::Report::ReachCriteria

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_3/classes.rb,
generated/google/apis/dfareporting_v3_3/representations.rb,
generated/google/apis/dfareporting_v3_3/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.



10302
10303
10304
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10302

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

Instance Attribute Details

#activities ⇒ Google::Apis::DfareportingV3_3::Activities

Represents an activity group. Corresponds to the JSON property activities

Returns:



10260
10261
10262
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10260

def activities
  @activities
end

#custom_rich_media_events ⇒ Google::Apis::DfareportingV3_3::CustomRichMediaEvents

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

Returns:



10265
10266
10267
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10265

def custom_rich_media_events
  @custom_rich_media_events
end

#date_range ⇒ Google::Apis::DfareportingV3_3::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



10270
10271
10272
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10270

def date_range
  @date_range
end

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



10277
10278
10279
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10277

def dimension_filters
  @dimension_filters
end

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

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

Returns:



10282
10283
10284
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10282

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) 


10289
10290
10291
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10289

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


10295
10296
10297
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10295

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


10300
10301
10302
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10300

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
 
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10307

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