Class: Google::Apis::DfareportingV4::Report::ReachCriteria

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReachCriteria

Returns a new instance of ReachCriteria.



11294
11295
11296
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11294

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

Instance Attribute Details

#activities ⇒ Google::Apis::DfareportingV4::Activities

Represents an activity group. Corresponds to the JSON property activities

Returns:



11252
11253
11254
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11252

def activities
  @activities
end

#custom_rich_media_events ⇒ Google::Apis::DfareportingV4::CustomRichMediaEvents

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

Returns:



11257
11258
11259
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11257

def custom_rich_media_events
  @custom_rich_media_events
end

#date_range ⇒ Google::Apis::DfareportingV4::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



11262
11263
11264
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11262

def date_range
  @date_range
end

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



11269
11270
11271
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11269

def dimension_filters
  @dimension_filters
end

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

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

Returns:



11274
11275
11276
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11274

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) 


11281
11282
11283
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11281

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


11287
11288
11289
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11287

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


11292
11293
11294
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11292

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11299

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