Class: Google::Apis::DfareportingV2_6::Report::ReachCriteria

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


9991
9992
9993
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9991

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

Instance Attribute Details

#activitiesGoogle::Apis::DfareportingV2_6::Activities

Represents an activity group. Corresponds to the JSON property activities


9949
9950
9951
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9949

def activities
  @activities
end

#custom_rich_media_eventsGoogle::Apis::DfareportingV2_6::CustomRichMediaEvents

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


9954
9955
9956
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9954

def custom_rich_media_events
  @custom_rich_media_events
end

#date_rangeGoogle::Apis::DfareportingV2_6::DateRange

Represents a date range. Corresponds to the JSON property dateRange


9959
9960
9961
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9959

def date_range
  @date_range
end

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


9966
9967
9968
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9966

def dimension_filters
  @dimension_filters
end

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

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


9971
9972
9973
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9971

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)

9978
9979
9980
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9978

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

9984
9985
9986
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9984

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

9989
9990
9991
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9989

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
# File 'generated/google/apis/dfareporting_v2_6/classes.rb', line 9996

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