Class: Google::Apis::DisplayvideoV3::Pacing
- Inherits:
-
Object
- Object
- Google::Apis::DisplayvideoV3::Pacing
- 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 rate at which a budget is spent.
Instance Attribute Summary collapse
-
#daily_max_impressions ⇒ Fixnum
Maximum number of impressions to serve every day.
-
#daily_max_micros ⇒ Fixnum
Maximum currency amount to spend every day in micros of advertiser's currency.
-
#pacing_period ⇒ String
Required.
-
#pacing_type ⇒ String
Required.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Pacing
constructor
A new instance of Pacing.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Pacing
Returns a new instance of Pacing.
10141 10142 10143 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10141 def initialize(**args) update!(**args) end |
Instance Attribute Details
#daily_max_impressions ⇒ Fixnum
Maximum number of impressions to serve every day. Applicable when the budget
is impression based. Must be greater than 0.
Corresponds to the JSON property dailyMaxImpressions
10111 10112 10113 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10111 def daily_max_impressions @daily_max_impressions end |
#daily_max_micros ⇒ Fixnum
Maximum currency amount to spend every day in micros of advertiser's currency.
Applicable when the budget is currency based. Must be greater than 0. For
example, for 1.5 standard unit of the currency, set this field to 1500000. The
value assigned will be rounded to whole billable units for the relevant
currency by the following rules: any positive value less than a single
billable unit will be rounded up to one billable unit and any value larger
than a single billable unit will be rounded down to the nearest billable value.
For example, if the currency's billable unit is 0.01, and this field is set
to 10257770, it will round down to 10250000, a value of 10.25. If set to 505,
it will round up to 10000, a value of 0.01.
Corresponds to the JSON property dailyMaxMicros
10125 10126 10127 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10125 def daily_max_micros @daily_max_micros end |
#pacing_period ⇒ String
Required. The time period in which the pacing budget will be spent. When
automatic budget allocation is enabled at the insertion order via
automationType, this field is output only and defaults to
PACING_PERIOD_FLIGHT
.
Corresponds to the JSON property pacingPeriod
10133 10134 10135 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10133 def pacing_period @pacing_period end |
#pacing_type ⇒ String
Required. The type of pacing that defines how the budget amount will be spent
across the pacing_period.
Corresponds to the JSON property pacingType
10139 10140 10141 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10139 def pacing_type @pacing_type end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
10146 10147 10148 10149 10150 10151 |
# File 'lib/google/apis/displayvideo_v3/classes.rb', line 10146 def update!(**args) @daily_max_impressions = args[:daily_max_impressions] if args.key?(:daily_max_impressions) @daily_max_micros = args[:daily_max_micros] if args.key?(:daily_max_micros) @pacing_period = args[:pacing_period] if args.key?(:pacing_period) @pacing_type = args[:pacing_type] if args.key?(:pacing_type) end |