Class: Google::Apis::DfareportingV3_3::Report::ReachCriteria
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_3::Report::ReachCriteria
- 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
-
#activities ⇒ Google::Apis::DfareportingV3_3::Activities
Represents an activity group.
-
#custom_rich_media_events ⇒ Google::Apis::DfareportingV3_3::CustomRichMediaEvents
Represents a Custom Rich Media Events group.
-
#date_range ⇒ Google::Apis::DfareportingV3_3::DateRange
Represents a date range.
-
#dimension_filters ⇒ Array<Google::Apis::DfareportingV3_3::DimensionValue>
The list of filters on which dimensions are filtered.
-
#dimensions ⇒ Array<Google::Apis::DfareportingV3_3::SortedDimension>
The list of dimensions the report should include.
-
#enable_all_dimension_combinations ⇒ Boolean
(also: #enable_all_dimension_combinations?)
Whether to enable all reach dimension combinations in the report.
-
#metric_names ⇒ Array<String>
The list of names of metrics the report should include.
-
#reach_by_frequency_metric_names ⇒ Array<String>
The list of names of Reach By Frequency metrics the report should include.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ReachCriteria
constructor
A new instance of ReachCriteria.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ReachCriteria
Returns a new instance of ReachCriteria
10301 10302 10303 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10301 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
10259 10260 10261 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10259 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
10264 10265 10266 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10264 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
10269 10270 10271 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10269 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
10276 10277 10278 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10276 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
10281 10282 10283 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10281 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
10288 10289 10290 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10288 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
10294 10295 10296 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10294 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
10299 10300 10301 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10299 def reach_by_frequency_metric_names @reach_by_frequency_metric_names end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
10306 10307 10308 10309 10310 10311 10312 10313 10314 10315 |
# File 'generated/google/apis/dfareporting_v3_3/classes.rb', line 10306 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 |