Class: Google::Apis::DfareportingV3_2::Report::ReachCriteria

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



10452
10453
10454
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 10452

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

Instance Attribute Details

#activities ⇒ Google::Apis::DfareportingV3_2::Activities

Represents an activity group. Corresponds to the JSON property activities

Returns:



10410
10411
10412
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 10410

def activities
  @activities
end

#custom_rich_media_events ⇒ Google::Apis::DfareportingV3_2::CustomRichMediaEvents

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

Returns:



10415
10416
10417
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 10415

def custom_rich_media_events
  @custom_rich_media_events
end

#date_range ⇒ Google::Apis::DfareportingV3_2::DateRange

Represents a date range. Corresponds to the JSON property dateRange

Returns:



10420
10421
10422
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 10420

def date_range
  @date_range
end

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



10427
10428
10429
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 10427

def dimension_filters
  @dimension_filters
end

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

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

Returns:



10432
10433
10434
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 10432

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) 


10439
10440
10441
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 10439

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


10445
10446
10447
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 10445

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


10450
10451
10452
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 10450

def reach_by_frequency_metric_names
  @reach_by_frequency_metric_names
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
 
# File 'generated/google/apis/dfareporting_v3_2/classes.rb', line 10457

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