Class: Google::Apis::DisplayvideoV3::FrequencyCap
- Inherits:
-
Object
- Object
- Google::Apis::DisplayvideoV3::FrequencyCap
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/displayvideo_v3/classes.rb,
lib/google/apis/displayvideo_v3/representations.rb,
lib/google/apis/displayvideo_v3/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
-
#max_impressions ⇒ Fixnum
The maximum number of times a user may be shown the same ad during this period.
-
#max_views ⇒ Fixnum
Optional.
-
#time_unit ⇒ String
The time unit in which the frequency cap will be applied.
-
#time_unit_count ⇒ Fixnum
The number of time_unit the frequency cap will last.
-
#unlimited ⇒ Boolean
(also: #unlimited?)
Whether unlimited frequency capping is applied.
Instance Method Summary collapse
-
#initialize(**args) ⇒ FrequencyCap
constructor
A new instance of FrequencyCap.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ FrequencyCap
Returns a new instance of FrequencyCap.
6439 6440 6441 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6439 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
6405 6406 6407 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6405 def max_impressions @max_impressions end |
#max_views ⇒ Fixnum
Optional. 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 0. Only applicable to YouTube and Partners resources. Required when
unlimited is false
and max_impressions is not set.
Corresponds to the JSON property maxViews
6413 6414 6415 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6413 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
6419 6420 6421 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6419 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
6430 6431 6432 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6430 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
6436 6437 6438 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6436 def unlimited @unlimited end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
6444 6445 6446 6447 6448 6449 6450 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 6444 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 |