docs: update docs (#916)
* fix: re-run script
* test: fix noxfile
diff --git a/docs/dyn/displayvideo_v1.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v1.advertisers.insertionOrders.html
index 396b4f2..b928978 100644
--- a/docs/dyn/displayvideo_v1.advertisers.insertionOrders.html
+++ b/docs/dyn/displayvideo_v1.advertisers.insertionOrders.html
@@ -84,7 +84,7 @@
<code><a href="#get">get(advertiserId, insertionOrderId, x__xgafv=None)</a></code></p>
<p class="firstline">Gets an insertion order.</p>
<p class="toc_element">
- <code><a href="#list">list(advertiserId, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p>
+ <code><a href="#list">list(advertiserId, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists insertion orders in an advertiser.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -104,14 +104,180 @@
The object takes the form of:
{ # A single insertion order.
+ "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
+ # fixed_bid is set.
+ # Bid strategy determines the bid price.
+ "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+ "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
+ # For insertion order entity,
+ # bid_amount_micros should be set as 0.
+ # For line item entity,
+ # bid_amount_micros must be greater
+ # than or equal to billable unit of the given currency and smaller than or
+ # equal to the upper limit 1000000000.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
+ # performance goal while spending the full budget.
+ #
+ # At insertion order level, the
+ # markup_type of line items
+ # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
+ # when
+ # performance_goal_type
+ # is one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
+ #
+ # the line_item_type
+ # of the insertion order line items must be either:
+ #
+ # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
+ # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
+ #
+ # and when
+ # performance_goal_type
+ # is either:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
+ #
+ # the line_item_type
+ # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+ # performance goal while spending the full budget.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # tries to minimize while spending the full budget.
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
+ # this strategy.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
+ # performance goal. It is to be used only for a line item entity.
+ # performance goal.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # will try to meet or beat.
+ #
+ # For line item level usage, the value must be one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency. Not applicable when
+ # performance_goal_type
+ # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
+ # meet or beat, in micros of the advertiser's currency.
+ # Must be greater than or equal to a billable unit of the given currency and
+ # smaller or equal to upper bounds. Each
+ # performance_goal_type
+ # has its upper bound:
+ #
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
+ # upper bound is 10000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
+ # upper bound is 1000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
+ # 1000.00 USD.
+ #
+ # Example: If set to
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
+ # be based on the probability that each available impression will be
+ # viewable. For example, if viewable CPM target is $2 and an impression is
+ # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ },
+ "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
+ # ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnitCount": 42, # The number of time_unit the frequency cap will
+ # last.
+ #
+ # Applicable 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
+ },
+ "displayName": "A String", # Required. The display name of the insertion order.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "partnerCosts": [ # The partner costs associated with the insertion order.
+ #
+ # If absent or empty in
+ # CreateInsertionOrder
+ # method, the newly created insertion order will inherit partner costs from
+ # the partner settings.
+ { # Settings that control a partner cost.
+ #
+ # A partner cost is any type of expense involved in running a campaign, other
+ # than the costs of purchasing impressions (which is called the media cost)
+ # and using third-party audience segment data (data fee). Some examples of
+ # partner costs include the fees for using DV360, a third-party ad server,
+ # or a third-party ad serving verification service.
+ "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
+ #
+ # For example, for 1.5 standard unit of the advertiser's currency, set
+ # this field to 1500000.
+ "costType": "A String", # Required. The type of the partner cost.
+ "feeType": "A String", # Required. The fee type for this partner cost.
+ "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
+ #
+ # For example: 100 represents 0.1%.
+ "invoiceType": "A String", # The invoice type for this partner cost.
+ #
+ # * Required when cost_type is one of:
+ # - `PARTNER_COST_TYPE_ADLOOX`
+ # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
+ # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
+ # * Output only for other types.
+ },
+ ],
+ "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
+ # Assigned by the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
"budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
- "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
- # impression based.
"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify
# a specific budget for a given period of time an insertion order is running.
{ # Settings that control the budget of a single budget segment.
- "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
- # segment.
"budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given
# date_range.
# The amount is in micros. Must be greater than 0. For example, 500000000
@@ -168,6 +334,8 @@
# the invoices.
#
# Must be UTF-8 encoded with a length of no more than 80 characters.
+ "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
+ # segment.
},
],
"automationType": "A String", # The type of automation used to manage bid and budget for
@@ -175,6 +343,8 @@
#
# If this field is unspecified in creation, the value defaults to
# `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+ "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
+ # impression based.
},
"entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget
# and bid on inventory.
@@ -189,6 +359,16 @@
# * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent
# campaign is not active.
"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+ "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
+ #
+ # When automatic budget allocation is enabled at the insertion order via
+ # auto_budget_allocation, this
+ # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+ "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
+ # spent across the pacing_period.
+ "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
+ #
+ # Applicable when the budget is impression based. Must be greater than 0.
"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of
# advertiser's currency.
#
@@ -204,19 +384,8 @@
# 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.
- "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
- #
- # When automatic budget allocation is enabled at the insertion order via
- # auto_budget_allocation, this
- # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
- "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
- # spent across the pacing_period.
- "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
- #
- # Applicable when the budget is impression based. Must be greater than 0.
},
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -243,10 +412,11 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
- "name": "A String", # Output only. The resource name of the insertion order.
- "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
"insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+ "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+ "name": "A String", # Output only. The resource name of the insertion order.
"integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order.
"details": "A String", # Additional details of the entry in string format.
#
@@ -257,176 +427,6 @@
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
- "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
- # fixed_bid is set.
- # Bid strategy determines the bid price.
- "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
- # performance goal. It is to be used only for a line item entity.
- # performance goal.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # will try to meet or beat.
- #
- # For line item level usage, the value must be one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency. Not applicable when
- # performance_goal_type
- # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
- # meet or beat, in micros of the advertiser's currency.
- # Must be greater than or equal to a billable unit of the given currency and
- # smaller or equal to upper bounds. Each
- # performance_goal_type
- # has its upper bound:
- #
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
- # upper bound is 10000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
- # upper bound is 1000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
- # 1000.00 USD.
- #
- # Example: If set to
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
- # be based on the probability that each available impression will be
- # viewable. For example, if viewable CPM target is $2 and an impression is
- # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
- "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
- # For insertion order entity,
- # bid_amount_micros should be set as 0.
- # For line item entity,
- # bid_amount_micros must be greater
- # than or equal to billable unit of the given currency and smaller than or
- # equal to the upper limit 1000000000.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
- # performance goal while spending the full budget.
- #
- # At insertion order level, the
- # markup_type of line items
- # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
- # when
- # performance_goal_type
- # is one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
- #
- # the line_item_type
- # of the insertion order line items must be either:
- #
- # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
- # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
- #
- # and when
- # performance_goal_type
- # is either:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
- #
- # the line_item_type
- # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- # performance goal while spending the full budget.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # tries to minimize while spending the full budget.
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
- # this strategy.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- },
- "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
- # ad during a given time period.
- "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
- #
- # Applicable when unlimited is `false`.
- "timeUnitCount": 42, # The number of time_unit the frequency cap will
- # last.
- #
- # Applicable 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
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
- },
- "displayName": "A String", # Required. The display name of the insertion order.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "partnerCosts": [ # The partner costs associated with the insertion order.
- #
- # If absent or empty in
- # CreateInsertionOrder
- # method, the newly created insertion order will inherit partner costs from
- # the partner settings.
- { # Settings that control a partner cost.
- #
- # A partner cost is any type of expense involved in running a campaign, other
- # than the costs of purchasing impressions (which is called the media cost)
- # and using third-party audience segment data (data fee). Some examples of
- # partner costs include the fees for using DV360, a third-party ad server,
- # or a third-party ad serving verification service.
- "costType": "A String", # Required. The type of the partner cost.
- "feeType": "A String", # Required. The fee type for this partner cost.
- "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
- #
- # For example: 100 represents 0.1%.
- "invoiceType": "A String", # The invoice type for this partner cost.
- #
- # * Required when cost_type is one of:
- # - `PARTNER_COST_TYPE_ADLOOX`
- # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
- # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
- # * Output only for other types.
- "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
- #
- # For example, for 1.5 standard unit of the advertiser's currency, set
- # this field to 1500000.
- },
- ],
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
- # Assigned by the system.
}
x__xgafv: string, V1 error format.
@@ -438,14 +438,180 @@
An object of the form:
{ # A single insertion order.
+ "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
+ # fixed_bid is set.
+ # Bid strategy determines the bid price.
+ "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+ "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
+ # For insertion order entity,
+ # bid_amount_micros should be set as 0.
+ # For line item entity,
+ # bid_amount_micros must be greater
+ # than or equal to billable unit of the given currency and smaller than or
+ # equal to the upper limit 1000000000.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
+ # performance goal while spending the full budget.
+ #
+ # At insertion order level, the
+ # markup_type of line items
+ # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
+ # when
+ # performance_goal_type
+ # is one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
+ #
+ # the line_item_type
+ # of the insertion order line items must be either:
+ #
+ # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
+ # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
+ #
+ # and when
+ # performance_goal_type
+ # is either:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
+ #
+ # the line_item_type
+ # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+ # performance goal while spending the full budget.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # tries to minimize while spending the full budget.
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
+ # this strategy.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
+ # performance goal. It is to be used only for a line item entity.
+ # performance goal.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # will try to meet or beat.
+ #
+ # For line item level usage, the value must be one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency. Not applicable when
+ # performance_goal_type
+ # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
+ # meet or beat, in micros of the advertiser's currency.
+ # Must be greater than or equal to a billable unit of the given currency and
+ # smaller or equal to upper bounds. Each
+ # performance_goal_type
+ # has its upper bound:
+ #
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
+ # upper bound is 10000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
+ # upper bound is 1000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
+ # 1000.00 USD.
+ #
+ # Example: If set to
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
+ # be based on the probability that each available impression will be
+ # viewable. For example, if viewable CPM target is $2 and an impression is
+ # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ },
+ "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
+ # ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnitCount": 42, # The number of time_unit the frequency cap will
+ # last.
+ #
+ # Applicable 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
+ },
+ "displayName": "A String", # Required. The display name of the insertion order.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "partnerCosts": [ # The partner costs associated with the insertion order.
+ #
+ # If absent or empty in
+ # CreateInsertionOrder
+ # method, the newly created insertion order will inherit partner costs from
+ # the partner settings.
+ { # Settings that control a partner cost.
+ #
+ # A partner cost is any type of expense involved in running a campaign, other
+ # than the costs of purchasing impressions (which is called the media cost)
+ # and using third-party audience segment data (data fee). Some examples of
+ # partner costs include the fees for using DV360, a third-party ad server,
+ # or a third-party ad serving verification service.
+ "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
+ #
+ # For example, for 1.5 standard unit of the advertiser's currency, set
+ # this field to 1500000.
+ "costType": "A String", # Required. The type of the partner cost.
+ "feeType": "A String", # Required. The fee type for this partner cost.
+ "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
+ #
+ # For example: 100 represents 0.1%.
+ "invoiceType": "A String", # The invoice type for this partner cost.
+ #
+ # * Required when cost_type is one of:
+ # - `PARTNER_COST_TYPE_ADLOOX`
+ # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
+ # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
+ # * Output only for other types.
+ },
+ ],
+ "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
+ # Assigned by the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
"budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
- "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
- # impression based.
"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify
# a specific budget for a given period of time an insertion order is running.
{ # Settings that control the budget of a single budget segment.
- "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
- # segment.
"budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given
# date_range.
# The amount is in micros. Must be greater than 0. For example, 500000000
@@ -502,6 +668,8 @@
# the invoices.
#
# Must be UTF-8 encoded with a length of no more than 80 characters.
+ "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
+ # segment.
},
],
"automationType": "A String", # The type of automation used to manage bid and budget for
@@ -509,6 +677,8 @@
#
# If this field is unspecified in creation, the value defaults to
# `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+ "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
+ # impression based.
},
"entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget
# and bid on inventory.
@@ -523,6 +693,16 @@
# * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent
# campaign is not active.
"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+ "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
+ #
+ # When automatic budget allocation is enabled at the insertion order via
+ # auto_budget_allocation, this
+ # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+ "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
+ # spent across the pacing_period.
+ "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
+ #
+ # Applicable when the budget is impression based. Must be greater than 0.
"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of
# advertiser's currency.
#
@@ -538,19 +718,8 @@
# 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.
- "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
- #
- # When automatic budget allocation is enabled at the insertion order via
- # auto_budget_allocation, this
- # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
- "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
- # spent across the pacing_period.
- "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
- #
- # Applicable when the budget is impression based. Must be greater than 0.
},
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -577,10 +746,11 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
- "name": "A String", # Output only. The resource name of the insertion order.
- "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
"insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+ "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+ "name": "A String", # Output only. The resource name of the insertion order.
"integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order.
"details": "A String", # Additional details of the entry in string format.
#
@@ -591,176 +761,6 @@
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
- "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
- # fixed_bid is set.
- # Bid strategy determines the bid price.
- "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
- # performance goal. It is to be used only for a line item entity.
- # performance goal.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # will try to meet or beat.
- #
- # For line item level usage, the value must be one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency. Not applicable when
- # performance_goal_type
- # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
- # meet or beat, in micros of the advertiser's currency.
- # Must be greater than or equal to a billable unit of the given currency and
- # smaller or equal to upper bounds. Each
- # performance_goal_type
- # has its upper bound:
- #
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
- # upper bound is 10000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
- # upper bound is 1000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
- # 1000.00 USD.
- #
- # Example: If set to
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
- # be based on the probability that each available impression will be
- # viewable. For example, if viewable CPM target is $2 and an impression is
- # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
- "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
- # For insertion order entity,
- # bid_amount_micros should be set as 0.
- # For line item entity,
- # bid_amount_micros must be greater
- # than or equal to billable unit of the given currency and smaller than or
- # equal to the upper limit 1000000000.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
- # performance goal while spending the full budget.
- #
- # At insertion order level, the
- # markup_type of line items
- # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
- # when
- # performance_goal_type
- # is one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
- #
- # the line_item_type
- # of the insertion order line items must be either:
- #
- # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
- # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
- #
- # and when
- # performance_goal_type
- # is either:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
- #
- # the line_item_type
- # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- # performance goal while spending the full budget.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # tries to minimize while spending the full budget.
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
- # this strategy.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- },
- "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
- # ad during a given time period.
- "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
- #
- # Applicable when unlimited is `false`.
- "timeUnitCount": 42, # The number of time_unit the frequency cap will
- # last.
- #
- # Applicable 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
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
- },
- "displayName": "A String", # Required. The display name of the insertion order.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "partnerCosts": [ # The partner costs associated with the insertion order.
- #
- # If absent or empty in
- # CreateInsertionOrder
- # method, the newly created insertion order will inherit partner costs from
- # the partner settings.
- { # Settings that control a partner cost.
- #
- # A partner cost is any type of expense involved in running a campaign, other
- # than the costs of purchasing impressions (which is called the media cost)
- # and using third-party audience segment data (data fee). Some examples of
- # partner costs include the fees for using DV360, a third-party ad server,
- # or a third-party ad serving verification service.
- "costType": "A String", # Required. The type of the partner cost.
- "feeType": "A String", # Required. The fee type for this partner cost.
- "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
- #
- # For example: 100 represents 0.1%.
- "invoiceType": "A String", # The invoice type for this partner cost.
- #
- # * Required when cost_type is one of:
- # - `PARTNER_COST_TYPE_ADLOOX`
- # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
- # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
- # * Output only for other types.
- "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
- #
- # For example, for 1.5 standard unit of the advertiser's currency, set
- # this field to 1500000.
- },
- ],
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
- # Assigned by the system.
}</pre>
</div>
@@ -812,14 +812,180 @@
An object of the form:
{ # A single insertion order.
+ "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
+ # fixed_bid is set.
+ # Bid strategy determines the bid price.
+ "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+ "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
+ # For insertion order entity,
+ # bid_amount_micros should be set as 0.
+ # For line item entity,
+ # bid_amount_micros must be greater
+ # than or equal to billable unit of the given currency and smaller than or
+ # equal to the upper limit 1000000000.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
+ # performance goal while spending the full budget.
+ #
+ # At insertion order level, the
+ # markup_type of line items
+ # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
+ # when
+ # performance_goal_type
+ # is one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
+ #
+ # the line_item_type
+ # of the insertion order line items must be either:
+ #
+ # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
+ # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
+ #
+ # and when
+ # performance_goal_type
+ # is either:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
+ #
+ # the line_item_type
+ # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+ # performance goal while spending the full budget.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # tries to minimize while spending the full budget.
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
+ # this strategy.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
+ # performance goal. It is to be used only for a line item entity.
+ # performance goal.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # will try to meet or beat.
+ #
+ # For line item level usage, the value must be one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency. Not applicable when
+ # performance_goal_type
+ # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
+ # meet or beat, in micros of the advertiser's currency.
+ # Must be greater than or equal to a billable unit of the given currency and
+ # smaller or equal to upper bounds. Each
+ # performance_goal_type
+ # has its upper bound:
+ #
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
+ # upper bound is 10000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
+ # upper bound is 1000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
+ # 1000.00 USD.
+ #
+ # Example: If set to
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
+ # be based on the probability that each available impression will be
+ # viewable. For example, if viewable CPM target is $2 and an impression is
+ # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ },
+ "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
+ # ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnitCount": 42, # The number of time_unit the frequency cap will
+ # last.
+ #
+ # Applicable 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
+ },
+ "displayName": "A String", # Required. The display name of the insertion order.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "partnerCosts": [ # The partner costs associated with the insertion order.
+ #
+ # If absent or empty in
+ # CreateInsertionOrder
+ # method, the newly created insertion order will inherit partner costs from
+ # the partner settings.
+ { # Settings that control a partner cost.
+ #
+ # A partner cost is any type of expense involved in running a campaign, other
+ # than the costs of purchasing impressions (which is called the media cost)
+ # and using third-party audience segment data (data fee). Some examples of
+ # partner costs include the fees for using DV360, a third-party ad server,
+ # or a third-party ad serving verification service.
+ "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
+ #
+ # For example, for 1.5 standard unit of the advertiser's currency, set
+ # this field to 1500000.
+ "costType": "A String", # Required. The type of the partner cost.
+ "feeType": "A String", # Required. The fee type for this partner cost.
+ "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
+ #
+ # For example: 100 represents 0.1%.
+ "invoiceType": "A String", # The invoice type for this partner cost.
+ #
+ # * Required when cost_type is one of:
+ # - `PARTNER_COST_TYPE_ADLOOX`
+ # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
+ # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
+ # * Output only for other types.
+ },
+ ],
+ "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
+ # Assigned by the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
"budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
- "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
- # impression based.
"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify
# a specific budget for a given period of time an insertion order is running.
{ # Settings that control the budget of a single budget segment.
- "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
- # segment.
"budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given
# date_range.
# The amount is in micros. Must be greater than 0. For example, 500000000
@@ -876,6 +1042,8 @@
# the invoices.
#
# Must be UTF-8 encoded with a length of no more than 80 characters.
+ "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
+ # segment.
},
],
"automationType": "A String", # The type of automation used to manage bid and budget for
@@ -883,6 +1051,8 @@
#
# If this field is unspecified in creation, the value defaults to
# `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+ "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
+ # impression based.
},
"entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget
# and bid on inventory.
@@ -897,6 +1067,16 @@
# * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent
# campaign is not active.
"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+ "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
+ #
+ # When automatic budget allocation is enabled at the insertion order via
+ # auto_budget_allocation, this
+ # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+ "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
+ # spent across the pacing_period.
+ "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
+ #
+ # Applicable when the budget is impression based. Must be greater than 0.
"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of
# advertiser's currency.
#
@@ -912,19 +1092,8 @@
# 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.
- "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
- #
- # When automatic budget allocation is enabled at the insertion order via
- # auto_budget_allocation, this
- # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
- "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
- # spent across the pacing_period.
- "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
- #
- # Applicable when the budget is impression based. Must be greater than 0.
},
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -951,10 +1120,11 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
- "name": "A String", # Output only. The resource name of the insertion order.
- "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
"insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+ "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+ "name": "A String", # Output only. The resource name of the insertion order.
"integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order.
"details": "A String", # Additional details of the entry in string format.
#
@@ -965,181 +1135,11 @@
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
- "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
- # fixed_bid is set.
- # Bid strategy determines the bid price.
- "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
- # performance goal. It is to be used only for a line item entity.
- # performance goal.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # will try to meet or beat.
- #
- # For line item level usage, the value must be one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency. Not applicable when
- # performance_goal_type
- # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
- # meet or beat, in micros of the advertiser's currency.
- # Must be greater than or equal to a billable unit of the given currency and
- # smaller or equal to upper bounds. Each
- # performance_goal_type
- # has its upper bound:
- #
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
- # upper bound is 10000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
- # upper bound is 1000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
- # 1000.00 USD.
- #
- # Example: If set to
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
- # be based on the probability that each available impression will be
- # viewable. For example, if viewable CPM target is $2 and an impression is
- # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
- "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
- # For insertion order entity,
- # bid_amount_micros should be set as 0.
- # For line item entity,
- # bid_amount_micros must be greater
- # than or equal to billable unit of the given currency and smaller than or
- # equal to the upper limit 1000000000.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
- # performance goal while spending the full budget.
- #
- # At insertion order level, the
- # markup_type of line items
- # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
- # when
- # performance_goal_type
- # is one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
- #
- # the line_item_type
- # of the insertion order line items must be either:
- #
- # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
- # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
- #
- # and when
- # performance_goal_type
- # is either:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
- #
- # the line_item_type
- # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- # performance goal while spending the full budget.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # tries to minimize while spending the full budget.
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
- # this strategy.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- },
- "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
- # ad during a given time period.
- "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
- #
- # Applicable when unlimited is `false`.
- "timeUnitCount": 42, # The number of time_unit the frequency cap will
- # last.
- #
- # Applicable 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
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
- },
- "displayName": "A String", # Required. The display name of the insertion order.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "partnerCosts": [ # The partner costs associated with the insertion order.
- #
- # If absent or empty in
- # CreateInsertionOrder
- # method, the newly created insertion order will inherit partner costs from
- # the partner settings.
- { # Settings that control a partner cost.
- #
- # A partner cost is any type of expense involved in running a campaign, other
- # than the costs of purchasing impressions (which is called the media cost)
- # and using third-party audience segment data (data fee). Some examples of
- # partner costs include the fees for using DV360, a third-party ad server,
- # or a third-party ad serving verification service.
- "costType": "A String", # Required. The type of the partner cost.
- "feeType": "A String", # Required. The fee type for this partner cost.
- "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
- #
- # For example: 100 represents 0.1%.
- "invoiceType": "A String", # The invoice type for this partner cost.
- #
- # * Required when cost_type is one of:
- # - `PARTNER_COST_TYPE_ADLOOX`
- # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
- # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
- # * Output only for other types.
- "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
- #
- # For example, for 1.5 standard unit of the advertiser's currency, set
- # this field to 1500000.
- },
- ],
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
- # Assigned by the system.
}</pre>
</div>
<div class="method">
- <code class="details" id="list">list(advertiserId, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</code>
+ <code class="details" id="list">list(advertiserId, filter=None, pageToken=None, orderBy=None, pageSize=None, x__xgafv=None)</code>
<pre>Lists insertion orders in an advertiser.
The order is defined by the order_by
@@ -1150,23 +1150,6 @@
Args:
advertiserId: string, Required. The ID of the advertiser to list insertion orders for. (required)
- pageToken: string, A token identifying a page of results the server should return.
-Typically, this is the value of
-next_page_token returned
-from the previous call to `ListInsertionOrders` method. If not specified,
-the first page of results will be returned.
- orderBy: string, Field by which to sort the list.
-Acceptable values are:
-
-* "displayName" (default)
-* "entityStatus"
-
-The default sorting order is ascending. To specify descending order for
-a field, a suffix "desc" should be added to the field name. Example:
-`displayName desc`.
- pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
-default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
-is specified.
filter: string, Allows filtering by insertion order properties.
Supported syntax:
@@ -1189,6 +1172,23 @@
entityStatus="ENTITY_STATUS_PAUSED")`
The length of this field should be no more than 500 characters.
+ pageToken: string, A token identifying a page of results the server should return.
+Typically, this is the value of
+next_page_token returned
+from the previous call to `ListInsertionOrders` method. If not specified,
+the first page of results will be returned.
+ orderBy: string, Field by which to sort the list.
+Acceptable values are:
+
+* "displayName" (default)
+* "entityStatus"
+
+The default sorting order is ascending. To specify descending order for
+a field, a suffix "desc" should be added to the field name. Example:
+`displayName desc`.
+ pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will
+default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value
+is specified.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -1202,14 +1202,180 @@
#
# This list will be absent if empty.
{ # A single insertion order.
+ "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
+ # fixed_bid is set.
+ # Bid strategy determines the bid price.
+ "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+ "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
+ # For insertion order entity,
+ # bid_amount_micros should be set as 0.
+ # For line item entity,
+ # bid_amount_micros must be greater
+ # than or equal to billable unit of the given currency and smaller than or
+ # equal to the upper limit 1000000000.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
+ # performance goal while spending the full budget.
+ #
+ # At insertion order level, the
+ # markup_type of line items
+ # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
+ # when
+ # performance_goal_type
+ # is one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
+ #
+ # the line_item_type
+ # of the insertion order line items must be either:
+ #
+ # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
+ # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
+ #
+ # and when
+ # performance_goal_type
+ # is either:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
+ #
+ # the line_item_type
+ # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+ # performance goal while spending the full budget.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # tries to minimize while spending the full budget.
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
+ # this strategy.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
+ # performance goal. It is to be used only for a line item entity.
+ # performance goal.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # will try to meet or beat.
+ #
+ # For line item level usage, the value must be one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency. Not applicable when
+ # performance_goal_type
+ # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
+ # meet or beat, in micros of the advertiser's currency.
+ # Must be greater than or equal to a billable unit of the given currency and
+ # smaller or equal to upper bounds. Each
+ # performance_goal_type
+ # has its upper bound:
+ #
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
+ # upper bound is 10000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
+ # upper bound is 1000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
+ # 1000.00 USD.
+ #
+ # Example: If set to
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
+ # be based on the probability that each available impression will be
+ # viewable. For example, if viewable CPM target is $2 and an impression is
+ # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ },
+ "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
+ # ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnitCount": 42, # The number of time_unit the frequency cap will
+ # last.
+ #
+ # Applicable 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
+ },
+ "displayName": "A String", # Required. The display name of the insertion order.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "partnerCosts": [ # The partner costs associated with the insertion order.
+ #
+ # If absent or empty in
+ # CreateInsertionOrder
+ # method, the newly created insertion order will inherit partner costs from
+ # the partner settings.
+ { # Settings that control a partner cost.
+ #
+ # A partner cost is any type of expense involved in running a campaign, other
+ # than the costs of purchasing impressions (which is called the media cost)
+ # and using third-party audience segment data (data fee). Some examples of
+ # partner costs include the fees for using DV360, a third-party ad server,
+ # or a third-party ad serving verification service.
+ "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
+ #
+ # For example, for 1.5 standard unit of the advertiser's currency, set
+ # this field to 1500000.
+ "costType": "A String", # Required. The type of the partner cost.
+ "feeType": "A String", # Required. The fee type for this partner cost.
+ "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
+ #
+ # For example: 100 represents 0.1%.
+ "invoiceType": "A String", # The invoice type for this partner cost.
+ #
+ # * Required when cost_type is one of:
+ # - `PARTNER_COST_TYPE_ADLOOX`
+ # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
+ # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
+ # * Output only for other types.
+ },
+ ],
+ "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
+ # Assigned by the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
"budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
- "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
- # impression based.
"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify
# a specific budget for a given period of time an insertion order is running.
{ # Settings that control the budget of a single budget segment.
- "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
- # segment.
"budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given
# date_range.
# The amount is in micros. Must be greater than 0. For example, 500000000
@@ -1266,6 +1432,8 @@
# the invoices.
#
# Must be UTF-8 encoded with a length of no more than 80 characters.
+ "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
+ # segment.
},
],
"automationType": "A String", # The type of automation used to manage bid and budget for
@@ -1273,6 +1441,8 @@
#
# If this field is unspecified in creation, the value defaults to
# `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+ "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
+ # impression based.
},
"entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget
# and bid on inventory.
@@ -1287,6 +1457,16 @@
# * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent
# campaign is not active.
"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+ "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
+ #
+ # When automatic budget allocation is enabled at the insertion order via
+ # auto_budget_allocation, this
+ # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+ "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
+ # spent across the pacing_period.
+ "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
+ #
+ # Applicable when the budget is impression based. Must be greater than 0.
"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of
# advertiser's currency.
#
@@ -1302,19 +1482,8 @@
# 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.
- "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
- #
- # When automatic budget allocation is enabled at the insertion order via
- # auto_budget_allocation, this
- # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
- "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
- # spent across the pacing_period.
- "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
- #
- # Applicable when the budget is impression based. Must be greater than 0.
},
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -1341,10 +1510,11 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
- "name": "A String", # Output only. The resource name of the insertion order.
- "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
"insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+ "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+ "name": "A String", # Output only. The resource name of the insertion order.
"integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order.
"details": "A String", # Additional details of the entry in string format.
#
@@ -1355,176 +1525,6 @@
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
- "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
- # fixed_bid is set.
- # Bid strategy determines the bid price.
- "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
- # performance goal. It is to be used only for a line item entity.
- # performance goal.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # will try to meet or beat.
- #
- # For line item level usage, the value must be one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency. Not applicable when
- # performance_goal_type
- # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
- # meet or beat, in micros of the advertiser's currency.
- # Must be greater than or equal to a billable unit of the given currency and
- # smaller or equal to upper bounds. Each
- # performance_goal_type
- # has its upper bound:
- #
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
- # upper bound is 10000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
- # upper bound is 1000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
- # 1000.00 USD.
- #
- # Example: If set to
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
- # be based on the probability that each available impression will be
- # viewable. For example, if viewable CPM target is $2 and an impression is
- # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
- "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
- # For insertion order entity,
- # bid_amount_micros should be set as 0.
- # For line item entity,
- # bid_amount_micros must be greater
- # than or equal to billable unit of the given currency and smaller than or
- # equal to the upper limit 1000000000.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
- # performance goal while spending the full budget.
- #
- # At insertion order level, the
- # markup_type of line items
- # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
- # when
- # performance_goal_type
- # is one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
- #
- # the line_item_type
- # of the insertion order line items must be either:
- #
- # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
- # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
- #
- # and when
- # performance_goal_type
- # is either:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
- #
- # the line_item_type
- # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- # performance goal while spending the full budget.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # tries to minimize while spending the full budget.
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
- # this strategy.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- },
- "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
- # ad during a given time period.
- "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
- #
- # Applicable when unlimited is `false`.
- "timeUnitCount": 42, # The number of time_unit the frequency cap will
- # last.
- #
- # Applicable 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
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
- },
- "displayName": "A String", # Required. The display name of the insertion order.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "partnerCosts": [ # The partner costs associated with the insertion order.
- #
- # If absent or empty in
- # CreateInsertionOrder
- # method, the newly created insertion order will inherit partner costs from
- # the partner settings.
- { # Settings that control a partner cost.
- #
- # A partner cost is any type of expense involved in running a campaign, other
- # than the costs of purchasing impressions (which is called the media cost)
- # and using third-party audience segment data (data fee). Some examples of
- # partner costs include the fees for using DV360, a third-party ad server,
- # or a third-party ad serving verification service.
- "costType": "A String", # Required. The type of the partner cost.
- "feeType": "A String", # Required. The fee type for this partner cost.
- "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
- #
- # For example: 100 represents 0.1%.
- "invoiceType": "A String", # The invoice type for this partner cost.
- #
- # * Required when cost_type is one of:
- # - `PARTNER_COST_TYPE_ADLOOX`
- # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
- # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
- # * Output only for other types.
- "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
- #
- # For example, for 1.5 standard unit of the advertiser's currency, set
- # this field to 1500000.
- },
- ],
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
- # Assigned by the system.
},
],
"nextPageToken": "A String", # A token to retrieve the next page of results.
@@ -1560,14 +1560,180 @@
The object takes the form of:
{ # A single insertion order.
+ "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
+ # fixed_bid is set.
+ # Bid strategy determines the bid price.
+ "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+ "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
+ # For insertion order entity,
+ # bid_amount_micros should be set as 0.
+ # For line item entity,
+ # bid_amount_micros must be greater
+ # than or equal to billable unit of the given currency and smaller than or
+ # equal to the upper limit 1000000000.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
+ # performance goal while spending the full budget.
+ #
+ # At insertion order level, the
+ # markup_type of line items
+ # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
+ # when
+ # performance_goal_type
+ # is one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
+ #
+ # the line_item_type
+ # of the insertion order line items must be either:
+ #
+ # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
+ # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
+ #
+ # and when
+ # performance_goal_type
+ # is either:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
+ #
+ # the line_item_type
+ # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+ # performance goal while spending the full budget.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # tries to minimize while spending the full budget.
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
+ # this strategy.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
+ # performance goal. It is to be used only for a line item entity.
+ # performance goal.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # will try to meet or beat.
+ #
+ # For line item level usage, the value must be one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency. Not applicable when
+ # performance_goal_type
+ # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
+ # meet or beat, in micros of the advertiser's currency.
+ # Must be greater than or equal to a billable unit of the given currency and
+ # smaller or equal to upper bounds. Each
+ # performance_goal_type
+ # has its upper bound:
+ #
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
+ # upper bound is 10000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
+ # upper bound is 1000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
+ # 1000.00 USD.
+ #
+ # Example: If set to
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
+ # be based on the probability that each available impression will be
+ # viewable. For example, if viewable CPM target is $2 and an impression is
+ # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ },
+ "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
+ # ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnitCount": 42, # The number of time_unit the frequency cap will
+ # last.
+ #
+ # Applicable 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
+ },
+ "displayName": "A String", # Required. The display name of the insertion order.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "partnerCosts": [ # The partner costs associated with the insertion order.
+ #
+ # If absent or empty in
+ # CreateInsertionOrder
+ # method, the newly created insertion order will inherit partner costs from
+ # the partner settings.
+ { # Settings that control a partner cost.
+ #
+ # A partner cost is any type of expense involved in running a campaign, other
+ # than the costs of purchasing impressions (which is called the media cost)
+ # and using third-party audience segment data (data fee). Some examples of
+ # partner costs include the fees for using DV360, a third-party ad server,
+ # or a third-party ad serving verification service.
+ "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
+ #
+ # For example, for 1.5 standard unit of the advertiser's currency, set
+ # this field to 1500000.
+ "costType": "A String", # Required. The type of the partner cost.
+ "feeType": "A String", # Required. The fee type for this partner cost.
+ "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
+ #
+ # For example: 100 represents 0.1%.
+ "invoiceType": "A String", # The invoice type for this partner cost.
+ #
+ # * Required when cost_type is one of:
+ # - `PARTNER_COST_TYPE_ADLOOX`
+ # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
+ # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
+ # * Output only for other types.
+ },
+ ],
+ "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
+ # Assigned by the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
"budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
- "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
- # impression based.
"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify
# a specific budget for a given period of time an insertion order is running.
{ # Settings that control the budget of a single budget segment.
- "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
- # segment.
"budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given
# date_range.
# The amount is in micros. Must be greater than 0. For example, 500000000
@@ -1624,6 +1790,8 @@
# the invoices.
#
# Must be UTF-8 encoded with a length of no more than 80 characters.
+ "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
+ # segment.
},
],
"automationType": "A String", # The type of automation used to manage bid and budget for
@@ -1631,6 +1799,8 @@
#
# If this field is unspecified in creation, the value defaults to
# `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+ "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
+ # impression based.
},
"entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget
# and bid on inventory.
@@ -1645,6 +1815,16 @@
# * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent
# campaign is not active.
"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+ "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
+ #
+ # When automatic budget allocation is enabled at the insertion order via
+ # auto_budget_allocation, this
+ # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+ "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
+ # spent across the pacing_period.
+ "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
+ #
+ # Applicable when the budget is impression based. Must be greater than 0.
"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of
# advertiser's currency.
#
@@ -1660,19 +1840,8 @@
# 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.
- "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
- #
- # When automatic budget allocation is enabled at the insertion order via
- # auto_budget_allocation, this
- # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
- "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
- # spent across the pacing_period.
- "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
- #
- # Applicable when the budget is impression based. Must be greater than 0.
},
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -1699,10 +1868,11 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
- "name": "A String", # Output only. The resource name of the insertion order.
- "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
"insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+ "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+ "name": "A String", # Output only. The resource name of the insertion order.
"integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order.
"details": "A String", # Additional details of the entry in string format.
#
@@ -1713,176 +1883,6 @@
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
- "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
- # fixed_bid is set.
- # Bid strategy determines the bid price.
- "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
- # performance goal. It is to be used only for a line item entity.
- # performance goal.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # will try to meet or beat.
- #
- # For line item level usage, the value must be one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency. Not applicable when
- # performance_goal_type
- # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
- # meet or beat, in micros of the advertiser's currency.
- # Must be greater than or equal to a billable unit of the given currency and
- # smaller or equal to upper bounds. Each
- # performance_goal_type
- # has its upper bound:
- #
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
- # upper bound is 10000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
- # upper bound is 1000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
- # 1000.00 USD.
- #
- # Example: If set to
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
- # be based on the probability that each available impression will be
- # viewable. For example, if viewable CPM target is $2 and an impression is
- # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
- "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
- # For insertion order entity,
- # bid_amount_micros should be set as 0.
- # For line item entity,
- # bid_amount_micros must be greater
- # than or equal to billable unit of the given currency and smaller than or
- # equal to the upper limit 1000000000.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
- # performance goal while spending the full budget.
- #
- # At insertion order level, the
- # markup_type of line items
- # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
- # when
- # performance_goal_type
- # is one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
- #
- # the line_item_type
- # of the insertion order line items must be either:
- #
- # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
- # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
- #
- # and when
- # performance_goal_type
- # is either:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
- #
- # the line_item_type
- # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- # performance goal while spending the full budget.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # tries to minimize while spending the full budget.
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
- # this strategy.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- },
- "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
- # ad during a given time period.
- "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
- #
- # Applicable when unlimited is `false`.
- "timeUnitCount": 42, # The number of time_unit the frequency cap will
- # last.
- #
- # Applicable 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
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
- },
- "displayName": "A String", # Required. The display name of the insertion order.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "partnerCosts": [ # The partner costs associated with the insertion order.
- #
- # If absent or empty in
- # CreateInsertionOrder
- # method, the newly created insertion order will inherit partner costs from
- # the partner settings.
- { # Settings that control a partner cost.
- #
- # A partner cost is any type of expense involved in running a campaign, other
- # than the costs of purchasing impressions (which is called the media cost)
- # and using third-party audience segment data (data fee). Some examples of
- # partner costs include the fees for using DV360, a third-party ad server,
- # or a third-party ad serving verification service.
- "costType": "A String", # Required. The type of the partner cost.
- "feeType": "A String", # Required. The fee type for this partner cost.
- "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
- #
- # For example: 100 represents 0.1%.
- "invoiceType": "A String", # The invoice type for this partner cost.
- #
- # * Required when cost_type is one of:
- # - `PARTNER_COST_TYPE_ADLOOX`
- # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
- # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
- # * Output only for other types.
- "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
- #
- # For example, for 1.5 standard unit of the advertiser's currency, set
- # this field to 1500000.
- },
- ],
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
- # Assigned by the system.
}
updateMask: string, Required. The mask to control which fields to update.
@@ -1895,14 +1895,180 @@
An object of the form:
{ # A single insertion order.
+ "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
+ # fixed_bid is set.
+ # Bid strategy determines the bid price.
+ "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
+ "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
+ # For insertion order entity,
+ # bid_amount_micros should be set as 0.
+ # For line item entity,
+ # bid_amount_micros must be greater
+ # than or equal to billable unit of the given currency and smaller than or
+ # equal to the upper limit 1000000000.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
+ # performance goal while spending the full budget.
+ #
+ # At insertion order level, the
+ # markup_type of line items
+ # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
+ # when
+ # performance_goal_type
+ # is one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
+ #
+ # the line_item_type
+ # of the insertion order line items must be either:
+ #
+ # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
+ # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
+ #
+ # and when
+ # performance_goal_type
+ # is either:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
+ #
+ # the line_item_type
+ # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
+ # performance goal while spending the full budget.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # tries to minimize while spending the full budget.
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
+ # this strategy.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
+ # performance goal. It is to be used only for a line item entity.
+ # performance goal.
+ "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
+ # will try to meet or beat.
+ #
+ # For line item level usage, the value must be one of:
+ #
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
+ # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
+ # currency. Must be greater than or equal to a billable unit of the given
+ # currency. Not applicable when
+ # performance_goal_type
+ # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
+ # meet or beat, in micros of the advertiser's currency.
+ # Must be greater than or equal to a billable unit of the given currency and
+ # smaller or equal to upper bounds. Each
+ # performance_goal_type
+ # has its upper bound:
+ #
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
+ # upper bound is 10000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
+ # upper bound is 1000.00 USD.
+ # * when
+ # performance_goal_type
+ # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
+ # 1000.00 USD.
+ #
+ # Example: If set to
+ # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
+ # be based on the probability that each available impression will be
+ # viewable. For example, if viewable CPM target is $2 and an impression is
+ # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
+ #
+ # For example, 1500000 represents 1.5 standard units of the currency.
+ },
+ },
+ "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
+ # ad during a given time period.
+ "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
+ # `true`, the remaining frequency cap fields are not applicable.
+ "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
+ # during this period. Must be greater than 0.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
+ #
+ # Applicable when unlimited is `false`.
+ "timeUnitCount": 42, # The number of time_unit the frequency cap will
+ # last.
+ #
+ # Applicable 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
+ },
+ "displayName": "A String", # Required. The display name of the insertion order.
+ #
+ # Must be UTF-8 encoded with a maximum size of 240 bytes.
+ "partnerCosts": [ # The partner costs associated with the insertion order.
+ #
+ # If absent or empty in
+ # CreateInsertionOrder
+ # method, the newly created insertion order will inherit partner costs from
+ # the partner settings.
+ { # Settings that control a partner cost.
+ #
+ # A partner cost is any type of expense involved in running a campaign, other
+ # than the costs of purchasing impressions (which is called the media cost)
+ # and using third-party audience segment data (data fee). Some examples of
+ # partner costs include the fees for using DV360, a third-party ad server,
+ # or a third-party ad serving verification service.
+ "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
+ #
+ # For example, for 1.5 standard unit of the advertiser's currency, set
+ # this field to 1500000.
+ "costType": "A String", # Required. The type of the partner cost.
+ "feeType": "A String", # Required. The fee type for this partner cost.
+ "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
+ #
+ # Applicable when the fee_type is
+ # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
+ #
+ # For example: 100 represents 0.1%.
+ "invoiceType": "A String", # The invoice type for this partner cost.
+ #
+ # * Required when cost_type is one of:
+ # - `PARTNER_COST_TYPE_ADLOOX`
+ # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
+ # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
+ # * Output only for other types.
+ },
+ ],
+ "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
+ # Assigned by the system.
+ "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
"budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order.
- "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
- # impression based.
"budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify
# a specific budget for a given period of time an insertion order is running.
{ # Settings that control the budget of a single budget segment.
- "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
- # segment.
"budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given
# date_range.
# The amount is in micros. Must be greater than 0. For example, 500000000
@@ -1959,6 +2125,8 @@
# the invoices.
#
# Must be UTF-8 encoded with a length of no more than 80 characters.
+ "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget
+ # segment.
},
],
"automationType": "A String", # The type of automation used to manage bid and budget for
@@ -1966,6 +2134,8 @@
#
# If this field is unspecified in creation, the value defaults to
# `INSERTION_ORDER_AUTOMATION_TYPE_NONE`.
+ "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or
+ # impression based.
},
"entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget
# and bid on inventory.
@@ -1980,6 +2150,16 @@
# * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent
# campaign is not active.
"pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order.
+ "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
+ #
+ # When automatic budget allocation is enabled at the insertion order via
+ # auto_budget_allocation, this
+ # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
+ "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
+ # spent across the pacing_period.
+ "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
+ #
+ # Applicable when the budget is impression based. Must be greater than 0.
"dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of
# advertiser's currency.
#
@@ -1995,19 +2175,8 @@
# 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.
- "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent.
- #
- # When automatic budget allocation is enabled at the insertion order via
- # auto_budget_allocation, this
- # field is output only and defaults to `PACING_PERIOD_FLIGHT`.
- "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be
- # spent across the pacing_period.
- "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day.
- #
- # Applicable when the budget is impression based. Must be greater than 0.
},
"performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order.
- "performanceGoalType": "A String", # Required. The type of the performance goal.
"performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency.
#
# Applicable when
@@ -2034,10 +2203,11 @@
# Applicable when
# performance_goal_type is set to
# `PERFORMANCE_GOAL_TYPE_OTHER`.
+ "performanceGoalType": "A String", # Required. The type of the performance goal.
},
- "name": "A String", # Output only. The resource name of the insertion order.
- "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
"insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system.
+ "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to.
+ "name": "A String", # Output only. The resource name of the insertion order.
"integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order.
"details": "A String", # Additional details of the entry in string format.
#
@@ -2048,176 +2218,6 @@
#
# Must be UTF-8 encoded with a length of no more than 500 characters.
},
- "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default,
- # fixed_bid is set.
- # Bid strategy determines the bid price.
- "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified # A strategy that automatically adjusts the bid to meet or beat a specified
- # performance goal. It is to be used only for a line item entity.
- # performance goal.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # will try to meet or beat.
- #
- # For line item level usage, the value must be one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency. Not applicable when
- # performance_goal_type
- # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to
- # meet or beat, in micros of the advertiser's currency.
- # Must be greater than or equal to a billable unit of the given currency and
- # smaller or equal to upper bounds. Each
- # performance_goal_type
- # has its upper bound:
- #
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`,
- # upper bound is 10000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`,
- # upper bound is 1000.00 USD.
- # * when
- # performance_goal_type
- # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is
- # 1000.00 USD.
- #
- # Example: If set to
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will
- # be based on the probability that each available impression will be
- # viewable. For example, if viewable CPM target is $2 and an impression is
- # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2).
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
- "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency.
- # For insertion order entity,
- # bid_amount_micros should be set as 0.
- # For line item entity,
- # bid_amount_micros must be greater
- # than or equal to billable unit of the given currency and smaller than or
- # equal to the upper limit 1000000000.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your
- # performance goal while spending the full budget.
- #
- # At insertion order level, the
- # markup_type of line items
- # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition,
- # when
- # performance_goal_type
- # is one of:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` ,
- #
- # the line_item_type
- # of the insertion order line items must be either:
- #
- # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT`
- # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` ,
- #
- # and when
- # performance_goal_type
- # is either:
- #
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA`
- # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN`
- #
- # the line_item_type
- # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- # performance goal while spending the full budget.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy
- # tries to minimize while spending the full budget.
- # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for
- # this strategy.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's
- # currency. Must be greater than or equal to a billable unit of the given
- # currency.
- #
- # For example, 1500000 represents 1.5 standard units of the currency.
- },
- },
- "frequencyCap": { # Settings that control the number of times a user may be shown with the same # Required. The frequency capping setting of the insertion order.
- # ad during a given time period.
- "timeUnit": "A String", # The time unit in which the frequency cap will be applied.
- #
- # Applicable when unlimited is `false`.
- "timeUnitCount": 42, # The number of time_unit the frequency cap will
- # last.
- #
- # Applicable 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
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to
- # `true`, the remaining frequency cap fields are not applicable.
- "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad
- # during this period. Must be greater than 0.
- #
- # Applicable when unlimited is `false`.
- },
- "displayName": "A String", # Required. The display name of the insertion order.
- #
- # Must be UTF-8 encoded with a maximum size of 240 bytes.
- "partnerCosts": [ # The partner costs associated with the insertion order.
- #
- # If absent or empty in
- # CreateInsertionOrder
- # method, the newly created insertion order will inherit partner costs from
- # the partner settings.
- { # Settings that control a partner cost.
- #
- # A partner cost is any type of expense involved in running a campaign, other
- # than the costs of purchasing impressions (which is called the media cost)
- # and using third-party audience segment data (data fee). Some examples of
- # partner costs include the fees for using DV360, a third-party ad server,
- # or a third-party ad serving verification service.
- "costType": "A String", # Required. The type of the partner cost.
- "feeType": "A String", # Required. The fee type for this partner cost.
- "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent).
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0.
- #
- # For example: 100 represents 0.1%.
- "invoiceType": "A String", # The invoice type for this partner cost.
- #
- # * Required when cost_type is one of:
- # - `PARTNER_COST_TYPE_ADLOOX`
- # - `PARTNER_COST_TYPE_DOUBLE_VERIFY`
- # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`.
- # * Output only for other types.
- "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency.
- #
- # Applicable when the fee_type is
- # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0.
- #
- # For example, for 1.5 standard unit of the advertiser's currency, set
- # this field to 1500000.
- },
- ],
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated.
- # Assigned by the system.
}</pre>
</div>