Class: Google::Apis::DfareportingV2_3::Report::ReachCriteria

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


9409
9410
9411
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9409

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

Instance Attribute Details

#activitiesGoogle::Apis::DfareportingV2_3::Activities

Represents an activity group. Corresponds to the JSON property activities


9367
9368
9369
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9367

def activities
  @activities
end

#custom_rich_media_eventsGoogle::Apis::DfareportingV2_3::CustomRichMediaEvents

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


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

def custom_rich_media_events
  @custom_rich_media_events
end

#date_rangeGoogle::Apis::DfareportingV2_3::DateRange

Represents a date range. Corresponds to the JSON property dateRange


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

def date_range
  @date_range
end

#dimension_filtersArray<Google::Apis::DfareportingV2_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


9384
9385
9386
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9384

def dimension_filters
  @dimension_filters
end

#dimensionsArray<Google::Apis::DfareportingV2_3::SortedDimension>

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


9389
9390
9391
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9389

def dimensions
  @dimensions
end

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

9396
9397
9398
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9396

def enable_all_dimension_combinations
  @enable_all_dimension_combinations
end

#metric_namesArray<String>

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

Returns:

  • (Array<String>)

9402
9403
9404
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9402

def metric_names
  @metric_names
end

#reach_by_frequency_metric_namesArray<String>

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

Returns:

  • (Array<String>)

9407
9408
9409
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9407

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
# File 'generated/google/apis/dfareporting_v2_3/classes.rb', line 9414

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