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.



11079
11080
11081
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11079

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:



11037
11038
11039
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11037

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:



11042
11043
11044
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11042

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:



11047
11048
11049
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11047

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:



11054
11055
11056
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11054

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:



11059
11060
11061
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11059

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) 


11066
11067
11068
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11066

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


11072
11073
11074
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11072

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


11077
11078
11079
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11077

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
 
# File 'lib/google/apis/dfareporting_v4/classes.rb', line 11084

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