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



10068
10069
10070
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10068

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:



10026
10027
10028
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10026

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:



10031
10032
10033
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10031

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:



10036
10037
10038
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10036

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:



10043
10044
10045
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10043

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:



10048
10049
10050
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10048

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) 


10055
10056
10057
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10055

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


10061
10062
10063
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10061

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


10066
10067
10068
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10066

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
 
# File 'generated/google/apis/dfareporting_v2_7/classes.rb', line 10073

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