Class: Google::Apis::DisplayvideoV2::FrequencyCap

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

Overview

Settings that control the number of times a user may be shown with the same ad during a given time period.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FrequencyCap

Returns a new instance of FrequencyCap.



5739
5740
5741
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5739

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

Instance Attribute Details

#max_impressions ⇒ Fixnum

The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is false and max_views is not set. Corresponds to the JSON property maxImpressions

Returns:

  • (Fixnum) 


5705
5706
5707
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5705

def max_impressions
  @max_impressions
end

#max_views ⇒ Fixnum

The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than

  1. Only applicable to YouTube and Partners resources. Required when unlimited is false and max_impressions is not set. Corresponds to the JSON property maxViews

Returns:

  • (Fixnum) 


5713
5714
5715
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5713

def max_views
  @max_views
end

#time_unit ⇒ String

The time unit in which the frequency cap will be applied. Required when unlimited is false. Corresponds to the JSON property timeUnit

Returns:

  • (String) 


5719
5720
5721
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5719

def time_unit
  @time_unit
end

#time_unit_count ⇒ Fixnum

The number of time_unit the frequency cap will last. Required when unlimited is false. The following restrictions apply based on the value of time_unit: * TIME_UNIT_LIFETIME - this field is output only and will default to 1 * TIME_UNIT_MONTHS - must be between 1 and 2 * TIME_UNIT_WEEKS - must be between 1 and 4 * TIME_UNIT_DAYS - must be between 1 and 6 * TIME_UNIT_HOURS - must be between 1 and 23 * TIME_UNIT_MINUTES - must be between 1 and 59 Corresponds to the JSON property timeUnitCount

Returns:

  • (Fixnum) 


5730
5731
5732
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5730

def time_unit_count
  @time_unit_count
end

#unlimited ⇒ Boolean Also known as: unlimited?

Whether unlimited frequency capping is applied. When this field is set to true, the remaining frequency cap fields are not applicable. Corresponds to the JSON property unlimited

Returns:

  • (Boolean) 


5736
5737
5738
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5736

def unlimited
  @unlimited
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5744
5745
5746
5747
5748
5749
5750
 
# File 'lib/google/apis/displayvideo_v2/classes.rb', line 5744

def update!(**args)
  @max_impressions = args[:max_impressions] if args.key?(:max_impressions)
  @max_views = args[:max_views] if args.key?(:max_views)
  @time_unit = args[:time_unit] if args.key?(:time_unit)
  @time_unit_count = args[:time_unit_count] if args.key?(:time_unit_count)
  @unlimited = args[:unlimited] if args.key?(:unlimited)
end