Class: Google::Apis::DfareportingV3_0::Report::ReachCriteria
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_0::Report::ReachCriteria
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_0/classes.rb,
generated/google/apis/dfareporting_v3_0/representations.rb,
generated/google/apis/dfareporting_v3_0/representations.rb
Overview
The report criteria for a report of type "REACH".
Instance Attribute Summary collapse
-
#activities ⇒ Google::Apis::DfareportingV3_0::Activities
Represents an activity group.
-
#custom_rich_media_events ⇒ Google::Apis::DfareportingV3_0::CustomRichMediaEvents
Represents a Custom Rich Media Events group.
-
#date_range ⇒ Google::Apis::DfareportingV3_0::DateRange
Represents a date range.
-
#dimension_filters ⇒ Array<Google::Apis::DfareportingV3_0::DimensionValue>
The list of filters on which dimensions are filtered.
-
#dimensions ⇒ Array<Google::Apis::DfareportingV3_0::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
10272 10273 10274 |
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 10272 def initialize(**args) update!(**args) end |
Instance Attribute Details
#activities ⇒ Google::Apis::DfareportingV3_0::Activities
Represents an activity group.
Corresponds to the JSON property activities
10230 10231 10232 |
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 10230 def activities @activities end |
#custom_rich_media_events ⇒ Google::Apis::DfareportingV3_0::CustomRichMediaEvents
Represents a Custom Rich Media Events group.
Corresponds to the JSON property customRichMediaEvents
10235 10236 10237 |
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 10235 def custom_rich_media_events @custom_rich_media_events end |
#date_range ⇒ Google::Apis::DfareportingV3_0::DateRange
Represents a date range.
Corresponds to the JSON property dateRange
10240 10241 10242 |
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 10240 def date_range @date_range end |
#dimension_filters ⇒ Array<Google::Apis::DfareportingV3_0::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
10247 10248 10249 |
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 10247 def dimension_filters @dimension_filters end |
#dimensions ⇒ Array<Google::Apis::DfareportingV3_0::SortedDimension>
The list of dimensions the report should include.
Corresponds to the JSON property dimensions
10252 10253 10254 |
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 10252 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
10259 10260 10261 |
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 10259 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
10265 10266 10267 |
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 10265 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
10270 10271 10272 |
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 10270 def reach_by_frequency_metric_names @reach_by_frequency_metric_names end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
10277 10278 10279 10280 10281 10282 10283 10284 10285 10286 |
# File 'generated/google/apis/dfareporting_v3_0/classes.rb', line 10277 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 |