Class: Google::Apis::DfareportingV2_7::Report::ReachCriteria

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

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ReachCriteria

Returns a new instance of ReachCriteria



10083
10084
10085
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10083

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

Instance Attribute Details

#activities ⇒ Google::Apis::DfareportingV2_7::Activities

Represents an activity group. Corresponds to the JSON property activities

Returns:



10041
10042
10043
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10041

def activities
  @activities
end

#custom_rich_media_events ⇒ Google::Apis::DfareportingV2_7::CustomRichMediaEvents

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

Returns:



10046
10047
10048
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10046

def custom_rich_media_events
  @custom_rich_media_events
end

#date_range ⇒ Google::Apis::DfareportingV2_7::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



10051
10052
10053
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10051

def date_range
  @date_range
end

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



10058
10059
10060
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10058

def dimension_filters
  @dimension_filters
end

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

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

Returns:



10063
10064
10065
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10063

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 three months. Corresponds to the JSON property enableAllDimensionCombinations

Returns:

  • (Boolean) 


10070
10071
10072
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10070

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


10076
10077
10078
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10076

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


10081
10082
10083
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10081

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10088

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