Class: Google::Apis::DfareportingV3_4::Report::ReachCriteria

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/dfareporting_v3_4/classes.rb,
generated/google/apis/dfareporting_v3_4/representations.rb,
generated/google/apis/dfareporting_v3_4/representations.rb

Overview

The report criteria for a report of type "REACH".

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReachCriteria

Returns a new instance of ReachCriteria.



11082
11083
11084
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 11082

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

Instance Attribute Details

#activities ⇒ Google::Apis::DfareportingV3_4::Activities

Represents an activity group. Corresponds to the JSON property activities

Returns:



11040
11041
11042
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 11040

def activities
  @activities
end

#custom_rich_media_events ⇒ Google::Apis::DfareportingV3_4::CustomRichMediaEvents

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

Returns:



11045
11046
11047
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 11045

def custom_rich_media_events
  @custom_rich_media_events
end

#date_range ⇒ Google::Apis::DfareportingV3_4::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



11050
11051
11052
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 11050

def date_range
  @date_range
end

#dimension_filters ⇒ Array<Google::Apis::DfareportingV3_4::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

Returns:



11057
11058
11059
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 11057

def dimension_filters
  @dimension_filters
end

#dimensions ⇒ Array<Google::Apis::DfareportingV3_4::SortedDimension>

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

Returns:



11062
11063
11064
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 11062

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

Returns:

  • (Boolean) 


11069
11070
11071
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 11069

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

Returns:

  • (Array<String>) 


11075
11076
11077
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 11075

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

Returns:

  • (Array<String>) 


11080
11081
11082
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 11080

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
 
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 11087

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