Class: Google::Apis::DfareportingV4::Report::ReachCriteria

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



10867
10868
10869
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10867

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

Instance Attribute Details

#activities ⇒ Google::Apis::DfareportingV4::Activities

Represents an activity group. Corresponds to the JSON property activities

Returns:



10825
10826
10827
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10825

def activities
  @activities
end

#custom_rich_media_events ⇒ Google::Apis::DfareportingV4::CustomRichMediaEvents

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

Returns:



10830
10831
10832
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10830

def custom_rich_media_events
  @custom_rich_media_events
end

#date_range ⇒ Google::Apis::DfareportingV4::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



10835
10836
10837
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10835

def date_range
  @date_range
end

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



10842
10843
10844
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10842

def dimension_filters
  @dimension_filters
end

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

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

Returns:



10847
10848
10849
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10847

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) 


10854
10855
10856
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10854

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


10860
10861
10862
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10860

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


10865
10866
10867
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10865

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 10872

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