Class: Google::Apis::DfareportingV3_5::Report::ReachCriteria
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_5::Report::ReachCriteria
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/dfareporting_v3_5/classes.rb,
lib/google/apis/dfareporting_v3_5/representations.rb,
lib/google/apis/dfareporting_v3_5/representations.rb
Overview
The report criteria for a report of type "REACH".
Instance Attribute Summary collapse
-
#activities ⇒ Google::Apis::DfareportingV3_5::Activities
Represents an activity group.
-
#custom_rich_media_events ⇒ Google::Apis::DfareportingV3_5::CustomRichMediaEvents
Represents a Custom Rich Media Events group.
-
#date_range ⇒ Google::Apis::DfareportingV3_5::DateRange
Represents a date range.
-
#dimension_filters ⇒ Array<Google::Apis::DfareportingV3_5::DimensionValue>
The list of filters on which dimensions are filtered.
-
#dimensions ⇒ Array<Google::Apis::DfareportingV3_5::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.
Constructor Details
#initialize(**args) ⇒ ReachCriteria
Returns a new instance of ReachCriteria.
10743 10744 10745 |
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10743 def initialize(**args) update!(**args) end |
Instance Attribute Details
#activities ⇒ Google::Apis::DfareportingV3_5::Activities
Represents an activity group.
Corresponds to the JSON property activities
10701 10702 10703 |
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10701 def activities @activities end |
#custom_rich_media_events ⇒ Google::Apis::DfareportingV3_5::CustomRichMediaEvents
Represents a Custom Rich Media Events group.
Corresponds to the JSON property customRichMediaEvents
10706 10707 10708 |
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10706 def custom_rich_media_events @custom_rich_media_events end |
#date_range ⇒ Google::Apis::DfareportingV3_5::DateRange
Represents a date range.
Corresponds to the JSON property dateRange
10711 10712 10713 |
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10711 def date_range @date_range end |
#dimension_filters ⇒ Array<Google::Apis::DfareportingV3_5::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
10718 10719 10720 |
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10718 def dimension_filters @dimension_filters end |
#dimensions ⇒ Array<Google::Apis::DfareportingV3_5::SortedDimension>
The list of dimensions the report should include.
Corresponds to the JSON property dimensions
10723 10724 10725 |
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10723 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
10730 10731 10732 |
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10730 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
10736 10737 10738 |
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10736 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
10741 10742 10743 |
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10741 def reach_by_frequency_metric_names @reach_by_frequency_metric_names end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
10748 10749 10750 10751 10752 10753 10754 10755 10756 10757 |
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10748 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 |