Class: Google::Apis::DfareportingV3_5::Report::ReachCriteria

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReachCriteria

Returns a new instance of ReachCriteria.



10741
10742
10743
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10741

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

Returns:



10699
10700
10701
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10699

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

Returns:



10704
10705
10706
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10704

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

Returns:



10709
10710
10711
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10709

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

Returns:



10716
10717
10718
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10716

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

Returns:



10721
10722
10723
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10721

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) 


10728
10729
10730
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10728

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


10734
10735
10736
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10734

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


10739
10740
10741
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10739

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
 
# File 'lib/google/apis/dfareporting_v3_5/classes.rb', line 10746

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