| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="displayvideo_v1.html">Display & Video 360 API</a> . <a href="displayvideo_v1.advertisers.html">advertisers</a> . <a href="displayvideo_v1.advertisers.insertionOrders.html">insertionOrders</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#create">create(advertiserId, body=None, x__xgafv=None)</a></code></p> |
| 79 | <p class="firstline">Creates a new insertion order.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#delete">delete(advertiserId, insertionOrderId, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Deletes an insertion order.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#get">get(advertiserId, insertionOrderId, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">Gets an insertion order.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list">list(advertiserId, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</a></code></p> |
| 88 | <p class="firstline">Lists insertion orders in an advertiser.</p> |
| 89 | <p class="toc_element"> |
| 90 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 91 | <p class="firstline">Retrieves the next page of results.</p> |
| 92 | <p class="toc_element"> |
| 93 | <code><a href="#patch">patch(advertiserId, insertionOrderId, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 94 | <p class="firstline">Updates an existing insertion order.</p> |
| 95 | <h3>Method Details</h3> |
| 96 | <div class="method"> |
| 97 | <code class="details" id="create">create(advertiserId, body=None, x__xgafv=None)</code> |
| 98 | <pre>Creates a new insertion order. |
| 99 | Returns the newly created insertion order if successful. |
| 100 | |
| 101 | Args: |
| 102 | advertiserId: string, Output only. The unique ID of the advertiser the insertion order belongs to. (required) |
| 103 | body: object, The request body. |
| 104 | The object takes the form of: |
| 105 | |
| 106 | { # A single insertion order. |
| 107 | "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. |
| 108 | "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or |
| 109 | # impression based. |
| 110 | "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify |
| 111 | # a specific budget for a given period of time an insertion order is running. |
| 112 | { # Settings that control the budget of a single budget segment. |
| 113 | "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget |
| 114 | # segment. |
| 115 | "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given |
| 116 | # date_range. |
| 117 | # The amount is in micros. Must be greater than 0. For example, 500000000 |
| 118 | # represents 500 standard units of the currency. |
| 119 | "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved |
| 120 | # relative to the parent advertiser's time zone. |
| 121 | # |
| 122 | # * When creating a new budget segment, both `start_date` and `end_date` |
| 123 | # must be in the future. |
| 124 | # * An existing budget segment with a `start_date` in the past has a mutable |
| 125 | # `end_date` but an immutable `start_date`. |
| 126 | # * `end_date` must be the `start_date` or later, both before the year 2037. |
| 127 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value |
| 128 | # for `year`, `month`, and `day`. |
| 129 | # and time zone are either specified elsewhere or are not significant. The date |
| 130 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 131 | # |
| 132 | # * A full date, with non-zero year, month and day values |
| 133 | # * A month and day value, with a zero year, e.g. an anniversary |
| 134 | # * A year on its own, with zero month and day values |
| 135 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 136 | # |
| 137 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 138 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 139 | # a year. |
| 140 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 141 | # if specifying a year by itself or a year and month where the day is not |
| 142 | # significant. |
| 143 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 144 | # month and day. |
| 145 | }, |
| 146 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value |
| 147 | # for `year`, `month`, and `day`. |
| 148 | # and time zone are either specified elsewhere or are not significant. The date |
| 149 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 150 | # |
| 151 | # * A full date, with non-zero year, month and day values |
| 152 | # * A month and day value, with a zero year, e.g. an anniversary |
| 153 | # * A year on its own, with zero month and day values |
| 154 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 155 | # |
| 156 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 157 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 158 | # a year. |
| 159 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 160 | # if specifying a year by itself or a year and month where the day is not |
| 161 | # significant. |
| 162 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 163 | # month and day. |
| 164 | }, |
| 165 | }, |
| 166 | "description": "A String", # The budget segment description. It can be used to enter Purchase Order |
| 167 | # information for each budget segment and have that information printed on |
| 168 | # the invoices. |
| 169 | # |
| 170 | # Must be UTF-8 encoded with a length of no more than 80 characters. |
| 171 | }, |
| 172 | ], |
| 173 | "automationType": "A String", # The type of automation used to manage bid and budget for |
| 174 | # the insertion order. |
| 175 | # |
| 176 | # If this field is unspecified in creation, the value defaults to |
| 177 | # `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. |
| 178 | }, |
| 179 | "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget |
| 180 | # and bid on inventory. |
| 181 | # |
| 182 | # * For |
| 183 | # CreateInsertionOrder method, |
| 184 | # only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use |
| 185 | # UpdateInsertionOrder method |
| 186 | # and update the status to `ENTITY_STATUS_ACTIVE` after creation. |
| 187 | # * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status |
| 188 | # from any other status. |
| 189 | # * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent |
| 190 | # campaign is not active. |
| 191 | "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. |
| 192 | "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| 193 | # advertiser's currency. |
| 194 | # |
| 195 | # Applicable when the budget is currency based. Must be greater than 0. |
| 196 | # For example, for 1.5 standard unit of the currency, set this field to |
| 197 | # 1500000. |
| 198 | # |
| 199 | # The value assigned will be rounded to whole billable units for the |
| 200 | # relevant currency by the following rules: any positive value less than a |
| 201 | # single billable unit will be rounded up to one billable unit and any |
| 202 | # value larger than a single billable unit will be rounded down to the |
| 203 | # nearest billable value. For example, if the currency's billable unit is |
| 204 | # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| 205 | # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| 206 | # 0.01. |
| 207 | "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| 208 | # |
| 209 | # When automatic budget allocation is enabled at the insertion order via |
| 210 | # auto_budget_allocation, this |
| 211 | # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| 212 | "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| 213 | # spent across the pacing_period. |
| 214 | "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| 215 | # |
| 216 | # Applicable when the budget is impression based. Must be greater than 0. |
| 217 | }, |
| 218 | "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order. |
| 219 | "performanceGoalType": "A String", # Required. The type of the performance goal. |
| 220 | "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. |
| 221 | # |
| 222 | # Applicable when |
| 223 | # performance_goal_type is one of: |
| 224 | # |
| 225 | # * `PERFORMANCE_GOAL_TYPE_CPM` |
| 226 | # * `PERFORMANCE_GOAL_TYPE_CPC` |
| 227 | # * `PERFORMANCE_GOAL_TYPE_CPA` |
| 228 | # * `PERFORMANCE_GOAL_TYPE_CPIAVC` |
| 229 | # |
| 230 | # For example 1500000 represents 1.5 standard units of the currency. |
| 231 | "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. |
| 232 | # |
| 233 | # Applicable when |
| 234 | # performance_goal_type is one of: |
| 235 | # |
| 236 | # * `PERFORMANCE_GOAL_TYPE_CTR` |
| 237 | # * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` |
| 238 | # |
| 239 | # For example, 70000 represents 7% (decimal 0.07). |
| 240 | "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. |
| 241 | # Must be UTF-8 encoded with a length of no more than 100 characters. |
| 242 | # |
| 243 | # Applicable when |
| 244 | # performance_goal_type is set to |
| 245 | # `PERFORMANCE_GOAL_TYPE_OTHER`. |
| 246 | }, |
| 247 | "name": "A String", # Output only. The resource name of the insertion order. |
| 248 | "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. |
| 249 | "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. |
| 250 | "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. |
| 251 | "details": "A String", # Additional details of the entry in string format. |
| 252 | # |
| 253 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 254 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 255 | # The integration code will show up together with the entry in many |
| 256 | # places in the system, for example, reporting. |
| 257 | # |
| 258 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 259 | }, |
| 260 | "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default, |
| 261 | # fixed_bid is set. |
| 262 | # Bid strategy determines the bid price. |
| 263 | "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 |
| 264 | # performance goal. It is to be used only for a line item entity. |
| 265 | # performance goal. |
| 266 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 267 | # will try to meet or beat. |
| 268 | # |
| 269 | # For line item level usage, the value must be one of: |
| 270 | # |
| 271 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 272 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 273 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 274 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 275 | # currency. Must be greater than or equal to a billable unit of the given |
| 276 | # currency. Not applicable when |
| 277 | # performance_goal_type |
| 278 | # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 279 | # |
| 280 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 281 | "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| 282 | # meet or beat, in micros of the advertiser's currency. |
| 283 | # Must be greater than or equal to a billable unit of the given currency and |
| 284 | # smaller or equal to upper bounds. Each |
| 285 | # performance_goal_type |
| 286 | # has its upper bound: |
| 287 | # |
| 288 | # * when |
| 289 | # performance_goal_type |
| 290 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| 291 | # upper bound is 10000.00 USD. |
| 292 | # * when |
| 293 | # performance_goal_type |
| 294 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| 295 | # upper bound is 1000.00 USD. |
| 296 | # * when |
| 297 | # performance_goal_type |
| 298 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| 299 | # 1000.00 USD. |
| 300 | # |
| 301 | # Example: If set to |
| 302 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will |
| 303 | # be based on the probability that each available impression will be |
| 304 | # viewable. For example, if viewable CPM target is $2 and an impression is |
| 305 | # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). |
| 306 | # |
| 307 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 308 | }, |
| 309 | "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| 310 | "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| 311 | # For insertion order entity, |
| 312 | # bid_amount_micros should be set as 0. |
| 313 | # For line item entity, |
| 314 | # bid_amount_micros must be greater |
| 315 | # than or equal to billable unit of the given currency and smaller than or |
| 316 | # equal to the upper limit 1000000000. |
| 317 | # |
| 318 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 319 | }, |
| 320 | "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your |
| 321 | # performance goal while spending the full budget. |
| 322 | # |
| 323 | # At insertion order level, the |
| 324 | # markup_type of line items |
| 325 | # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, |
| 326 | # when |
| 327 | # performance_goal_type |
| 328 | # is one of: |
| 329 | # |
| 330 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 331 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 332 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , |
| 333 | # |
| 334 | # the line_item_type |
| 335 | # of the insertion order line items must be either: |
| 336 | # |
| 337 | # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` |
| 338 | # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , |
| 339 | # |
| 340 | # and when |
| 341 | # performance_goal_type |
| 342 | # is either: |
| 343 | # |
| 344 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` |
| 345 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` |
| 346 | # |
| 347 | # the line_item_type |
| 348 | # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. |
| 349 | # performance goal while spending the full budget. |
| 350 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 351 | # tries to minimize while spending the full budget. |
| 352 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| 353 | # this strategy. |
| 354 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 355 | # currency. Must be greater than or equal to a billable unit of the given |
| 356 | # currency. |
| 357 | # |
| 358 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 359 | }, |
| 360 | }, |
| 361 | "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. |
| 362 | # ad during a given time period. |
| 363 | "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| 364 | # |
| 365 | # Applicable when unlimited is `false`. |
| 366 | "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| 367 | # last. |
| 368 | # |
| 369 | # Applicable when unlimited is `false`. |
| 370 | # The following restrictions apply based on the value of |
| 371 | # time_unit: |
| 372 | # |
| 373 | # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| 374 | # default to 1 |
| 375 | # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| 376 | # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| 377 | # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| 378 | # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| 379 | # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| 380 | "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| 381 | # `true`, the remaining frequency cap fields are not applicable. |
| 382 | "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| 383 | # during this period. Must be greater than 0. |
| 384 | # |
| 385 | # Applicable when unlimited is `false`. |
| 386 | }, |
| 387 | "displayName": "A String", # Required. The display name of the insertion order. |
| 388 | # |
| 389 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 390 | "partnerCosts": [ # The partner costs associated with the insertion order. |
| 391 | # |
| 392 | # If absent or empty in |
| 393 | # CreateInsertionOrder |
| 394 | # method, the newly created insertion order will inherit partner costs from |
| 395 | # the partner settings. |
| 396 | { # Settings that control a partner cost. |
| 397 | # |
| 398 | # A partner cost is any type of expense involved in running a campaign, other |
| 399 | # than the costs of purchasing impressions (which is called the media cost) |
| 400 | # and using third-party audience segment data (data fee). Some examples of |
| 401 | # partner costs include the fees for using DV360, a third-party ad server, |
| 402 | # or a third-party ad serving verification service. |
| 403 | "costType": "A String", # Required. The type of the partner cost. |
| 404 | "feeType": "A String", # Required. The fee type for this partner cost. |
| 405 | "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| 406 | # |
| 407 | # Applicable when the fee_type is |
| 408 | # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| 409 | # |
| 410 | # For example: 100 represents 0.1%. |
| 411 | "invoiceType": "A String", # The invoice type for this partner cost. |
| 412 | # |
| 413 | # * Required when cost_type is one of: |
| 414 | # - `PARTNER_COST_TYPE_ADLOOX` |
| 415 | # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| 416 | # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| 417 | # * Output only for other types. |
| 418 | "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| 419 | # |
| 420 | # Applicable when the fee_type is |
| 421 | # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| 422 | # |
| 423 | # For example, for 1.5 standard unit of the advertiser's currency, set |
| 424 | # this field to 1500000. |
| 425 | }, |
| 426 | ], |
| 427 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. |
| 428 | "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. |
| 429 | # Assigned by the system. |
| 430 | } |
| 431 | |
| 432 | x__xgafv: string, V1 error format. |
| 433 | Allowed values |
| 434 | 1 - v1 error format |
| 435 | 2 - v2 error format |
| 436 | |
| 437 | Returns: |
| 438 | An object of the form: |
| 439 | |
| 440 | { # A single insertion order. |
| 441 | "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. |
| 442 | "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or |
| 443 | # impression based. |
| 444 | "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify |
| 445 | # a specific budget for a given period of time an insertion order is running. |
| 446 | { # Settings that control the budget of a single budget segment. |
| 447 | "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget |
| 448 | # segment. |
| 449 | "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given |
| 450 | # date_range. |
| 451 | # The amount is in micros. Must be greater than 0. For example, 500000000 |
| 452 | # represents 500 standard units of the currency. |
| 453 | "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved |
| 454 | # relative to the parent advertiser's time zone. |
| 455 | # |
| 456 | # * When creating a new budget segment, both `start_date` and `end_date` |
| 457 | # must be in the future. |
| 458 | # * An existing budget segment with a `start_date` in the past has a mutable |
| 459 | # `end_date` but an immutable `start_date`. |
| 460 | # * `end_date` must be the `start_date` or later, both before the year 2037. |
| 461 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value |
| 462 | # for `year`, `month`, and `day`. |
| 463 | # and time zone are either specified elsewhere or are not significant. The date |
| 464 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 465 | # |
| 466 | # * A full date, with non-zero year, month and day values |
| 467 | # * A month and day value, with a zero year, e.g. an anniversary |
| 468 | # * A year on its own, with zero month and day values |
| 469 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 470 | # |
| 471 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 472 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 473 | # a year. |
| 474 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 475 | # if specifying a year by itself or a year and month where the day is not |
| 476 | # significant. |
| 477 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 478 | # month and day. |
| 479 | }, |
| 480 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value |
| 481 | # for `year`, `month`, and `day`. |
| 482 | # and time zone are either specified elsewhere or are not significant. The date |
| 483 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 484 | # |
| 485 | # * A full date, with non-zero year, month and day values |
| 486 | # * A month and day value, with a zero year, e.g. an anniversary |
| 487 | # * A year on its own, with zero month and day values |
| 488 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 489 | # |
| 490 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 491 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 492 | # a year. |
| 493 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 494 | # if specifying a year by itself or a year and month where the day is not |
| 495 | # significant. |
| 496 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 497 | # month and day. |
| 498 | }, |
| 499 | }, |
| 500 | "description": "A String", # The budget segment description. It can be used to enter Purchase Order |
| 501 | # information for each budget segment and have that information printed on |
| 502 | # the invoices. |
| 503 | # |
| 504 | # Must be UTF-8 encoded with a length of no more than 80 characters. |
| 505 | }, |
| 506 | ], |
| 507 | "automationType": "A String", # The type of automation used to manage bid and budget for |
| 508 | # the insertion order. |
| 509 | # |
| 510 | # If this field is unspecified in creation, the value defaults to |
| 511 | # `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. |
| 512 | }, |
| 513 | "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget |
| 514 | # and bid on inventory. |
| 515 | # |
| 516 | # * For |
| 517 | # CreateInsertionOrder method, |
| 518 | # only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use |
| 519 | # UpdateInsertionOrder method |
| 520 | # and update the status to `ENTITY_STATUS_ACTIVE` after creation. |
| 521 | # * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status |
| 522 | # from any other status. |
| 523 | # * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent |
| 524 | # campaign is not active. |
| 525 | "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. |
| 526 | "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| 527 | # advertiser's currency. |
| 528 | # |
| 529 | # Applicable when the budget is currency based. Must be greater than 0. |
| 530 | # For example, for 1.5 standard unit of the currency, set this field to |
| 531 | # 1500000. |
| 532 | # |
| 533 | # The value assigned will be rounded to whole billable units for the |
| 534 | # relevant currency by the following rules: any positive value less than a |
| 535 | # single billable unit will be rounded up to one billable unit and any |
| 536 | # value larger than a single billable unit will be rounded down to the |
| 537 | # nearest billable value. For example, if the currency's billable unit is |
| 538 | # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| 539 | # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| 540 | # 0.01. |
| 541 | "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| 542 | # |
| 543 | # When automatic budget allocation is enabled at the insertion order via |
| 544 | # auto_budget_allocation, this |
| 545 | # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| 546 | "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| 547 | # spent across the pacing_period. |
| 548 | "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| 549 | # |
| 550 | # Applicable when the budget is impression based. Must be greater than 0. |
| 551 | }, |
| 552 | "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order. |
| 553 | "performanceGoalType": "A String", # Required. The type of the performance goal. |
| 554 | "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. |
| 555 | # |
| 556 | # Applicable when |
| 557 | # performance_goal_type is one of: |
| 558 | # |
| 559 | # * `PERFORMANCE_GOAL_TYPE_CPM` |
| 560 | # * `PERFORMANCE_GOAL_TYPE_CPC` |
| 561 | # * `PERFORMANCE_GOAL_TYPE_CPA` |
| 562 | # * `PERFORMANCE_GOAL_TYPE_CPIAVC` |
| 563 | # |
| 564 | # For example 1500000 represents 1.5 standard units of the currency. |
| 565 | "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. |
| 566 | # |
| 567 | # Applicable when |
| 568 | # performance_goal_type is one of: |
| 569 | # |
| 570 | # * `PERFORMANCE_GOAL_TYPE_CTR` |
| 571 | # * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` |
| 572 | # |
| 573 | # For example, 70000 represents 7% (decimal 0.07). |
| 574 | "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. |
| 575 | # Must be UTF-8 encoded with a length of no more than 100 characters. |
| 576 | # |
| 577 | # Applicable when |
| 578 | # performance_goal_type is set to |
| 579 | # `PERFORMANCE_GOAL_TYPE_OTHER`. |
| 580 | }, |
| 581 | "name": "A String", # Output only. The resource name of the insertion order. |
| 582 | "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. |
| 583 | "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. |
| 584 | "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. |
| 585 | "details": "A String", # Additional details of the entry in string format. |
| 586 | # |
| 587 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 588 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 589 | # The integration code will show up together with the entry in many |
| 590 | # places in the system, for example, reporting. |
| 591 | # |
| 592 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 593 | }, |
| 594 | "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default, |
| 595 | # fixed_bid is set. |
| 596 | # Bid strategy determines the bid price. |
| 597 | "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 |
| 598 | # performance goal. It is to be used only for a line item entity. |
| 599 | # performance goal. |
| 600 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 601 | # will try to meet or beat. |
| 602 | # |
| 603 | # For line item level usage, the value must be one of: |
| 604 | # |
| 605 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 606 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 607 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 608 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 609 | # currency. Must be greater than or equal to a billable unit of the given |
| 610 | # currency. Not applicable when |
| 611 | # performance_goal_type |
| 612 | # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 613 | # |
| 614 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 615 | "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| 616 | # meet or beat, in micros of the advertiser's currency. |
| 617 | # Must be greater than or equal to a billable unit of the given currency and |
| 618 | # smaller or equal to upper bounds. Each |
| 619 | # performance_goal_type |
| 620 | # has its upper bound: |
| 621 | # |
| 622 | # * when |
| 623 | # performance_goal_type |
| 624 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| 625 | # upper bound is 10000.00 USD. |
| 626 | # * when |
| 627 | # performance_goal_type |
| 628 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| 629 | # upper bound is 1000.00 USD. |
| 630 | # * when |
| 631 | # performance_goal_type |
| 632 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| 633 | # 1000.00 USD. |
| 634 | # |
| 635 | # Example: If set to |
| 636 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will |
| 637 | # be based on the probability that each available impression will be |
| 638 | # viewable. For example, if viewable CPM target is $2 and an impression is |
| 639 | # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). |
| 640 | # |
| 641 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 642 | }, |
| 643 | "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| 644 | "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| 645 | # For insertion order entity, |
| 646 | # bid_amount_micros should be set as 0. |
| 647 | # For line item entity, |
| 648 | # bid_amount_micros must be greater |
| 649 | # than or equal to billable unit of the given currency and smaller than or |
| 650 | # equal to the upper limit 1000000000. |
| 651 | # |
| 652 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 653 | }, |
| 654 | "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your |
| 655 | # performance goal while spending the full budget. |
| 656 | # |
| 657 | # At insertion order level, the |
| 658 | # markup_type of line items |
| 659 | # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, |
| 660 | # when |
| 661 | # performance_goal_type |
| 662 | # is one of: |
| 663 | # |
| 664 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 665 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 666 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , |
| 667 | # |
| 668 | # the line_item_type |
| 669 | # of the insertion order line items must be either: |
| 670 | # |
| 671 | # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` |
| 672 | # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , |
| 673 | # |
| 674 | # and when |
| 675 | # performance_goal_type |
| 676 | # is either: |
| 677 | # |
| 678 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` |
| 679 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` |
| 680 | # |
| 681 | # the line_item_type |
| 682 | # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. |
| 683 | # performance goal while spending the full budget. |
| 684 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 685 | # tries to minimize while spending the full budget. |
| 686 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| 687 | # this strategy. |
| 688 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 689 | # currency. Must be greater than or equal to a billable unit of the given |
| 690 | # currency. |
| 691 | # |
| 692 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 693 | }, |
| 694 | }, |
| 695 | "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. |
| 696 | # ad during a given time period. |
| 697 | "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| 698 | # |
| 699 | # Applicable when unlimited is `false`. |
| 700 | "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| 701 | # last. |
| 702 | # |
| 703 | # Applicable when unlimited is `false`. |
| 704 | # The following restrictions apply based on the value of |
| 705 | # time_unit: |
| 706 | # |
| 707 | # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| 708 | # default to 1 |
| 709 | # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| 710 | # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| 711 | # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| 712 | # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| 713 | # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| 714 | "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| 715 | # `true`, the remaining frequency cap fields are not applicable. |
| 716 | "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| 717 | # during this period. Must be greater than 0. |
| 718 | # |
| 719 | # Applicable when unlimited is `false`. |
| 720 | }, |
| 721 | "displayName": "A String", # Required. The display name of the insertion order. |
| 722 | # |
| 723 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 724 | "partnerCosts": [ # The partner costs associated with the insertion order. |
| 725 | # |
| 726 | # If absent or empty in |
| 727 | # CreateInsertionOrder |
| 728 | # method, the newly created insertion order will inherit partner costs from |
| 729 | # the partner settings. |
| 730 | { # Settings that control a partner cost. |
| 731 | # |
| 732 | # A partner cost is any type of expense involved in running a campaign, other |
| 733 | # than the costs of purchasing impressions (which is called the media cost) |
| 734 | # and using third-party audience segment data (data fee). Some examples of |
| 735 | # partner costs include the fees for using DV360, a third-party ad server, |
| 736 | # or a third-party ad serving verification service. |
| 737 | "costType": "A String", # Required. The type of the partner cost. |
| 738 | "feeType": "A String", # Required. The fee type for this partner cost. |
| 739 | "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| 740 | # |
| 741 | # Applicable when the fee_type is |
| 742 | # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| 743 | # |
| 744 | # For example: 100 represents 0.1%. |
| 745 | "invoiceType": "A String", # The invoice type for this partner cost. |
| 746 | # |
| 747 | # * Required when cost_type is one of: |
| 748 | # - `PARTNER_COST_TYPE_ADLOOX` |
| 749 | # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| 750 | # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| 751 | # * Output only for other types. |
| 752 | "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| 753 | # |
| 754 | # Applicable when the fee_type is |
| 755 | # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| 756 | # |
| 757 | # For example, for 1.5 standard unit of the advertiser's currency, set |
| 758 | # this field to 1500000. |
| 759 | }, |
| 760 | ], |
| 761 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. |
| 762 | "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. |
| 763 | # Assigned by the system. |
| 764 | }</pre> |
| 765 | </div> |
| 766 | |
| 767 | <div class="method"> |
| 768 | <code class="details" id="delete">delete(advertiserId, insertionOrderId, x__xgafv=None)</code> |
| 769 | <pre>Deletes an insertion order. |
| 770 | Returns error code `NOT_FOUND` if the insertion order does not exist. |
| 771 | The insertion order should be archived first, i.e. set |
| 772 | entity_status to `ENTITY_STATUS_ARCHIVED`, |
| 773 | to be able to delete it. |
| 774 | |
| 775 | Args: |
| 776 | advertiserId: string, The ID of the advertiser this insertion order belongs to. (required) |
| 777 | insertionOrderId: string, The ID of the insertion order we need to delete. (required) |
| 778 | x__xgafv: string, V1 error format. |
| 779 | Allowed values |
| 780 | 1 - v1 error format |
| 781 | 2 - v2 error format |
| 782 | |
| 783 | Returns: |
| 784 | An object of the form: |
| 785 | |
| 786 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 787 | # empty messages in your APIs. A typical example is to use it as the request |
| 788 | # or the response type of an API method. For instance: |
| 789 | # |
| 790 | # service Foo { |
| 791 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 792 | # } |
| 793 | # |
| 794 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 795 | }</pre> |
| 796 | </div> |
| 797 | |
| 798 | <div class="method"> |
| 799 | <code class="details" id="get">get(advertiserId, insertionOrderId, x__xgafv=None)</code> |
| 800 | <pre>Gets an insertion order. |
| 801 | Returns error code `NOT_FOUND` if the insertion order does not exist. |
| 802 | |
| 803 | Args: |
| 804 | advertiserId: string, Required. The ID of the advertiser this insertion order belongs to. (required) |
| 805 | insertionOrderId: string, Required. The ID of the insertion order to fetch. (required) |
| 806 | x__xgafv: string, V1 error format. |
| 807 | Allowed values |
| 808 | 1 - v1 error format |
| 809 | 2 - v2 error format |
| 810 | |
| 811 | Returns: |
| 812 | An object of the form: |
| 813 | |
| 814 | { # A single insertion order. |
| 815 | "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. |
| 816 | "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or |
| 817 | # impression based. |
| 818 | "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify |
| 819 | # a specific budget for a given period of time an insertion order is running. |
| 820 | { # Settings that control the budget of a single budget segment. |
| 821 | "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget |
| 822 | # segment. |
| 823 | "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given |
| 824 | # date_range. |
| 825 | # The amount is in micros. Must be greater than 0. For example, 500000000 |
| 826 | # represents 500 standard units of the currency. |
| 827 | "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved |
| 828 | # relative to the parent advertiser's time zone. |
| 829 | # |
| 830 | # * When creating a new budget segment, both `start_date` and `end_date` |
| 831 | # must be in the future. |
| 832 | # * An existing budget segment with a `start_date` in the past has a mutable |
| 833 | # `end_date` but an immutable `start_date`. |
| 834 | # * `end_date` must be the `start_date` or later, both before the year 2037. |
| 835 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value |
| 836 | # for `year`, `month`, and `day`. |
| 837 | # and time zone are either specified elsewhere or are not significant. The date |
| 838 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 839 | # |
| 840 | # * A full date, with non-zero year, month and day values |
| 841 | # * A month and day value, with a zero year, e.g. an anniversary |
| 842 | # * A year on its own, with zero month and day values |
| 843 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 844 | # |
| 845 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 846 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 847 | # a year. |
| 848 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 849 | # if specifying a year by itself or a year and month where the day is not |
| 850 | # significant. |
| 851 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 852 | # month and day. |
| 853 | }, |
| 854 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value |
| 855 | # for `year`, `month`, and `day`. |
| 856 | # and time zone are either specified elsewhere or are not significant. The date |
| 857 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 858 | # |
| 859 | # * A full date, with non-zero year, month and day values |
| 860 | # * A month and day value, with a zero year, e.g. an anniversary |
| 861 | # * A year on its own, with zero month and day values |
| 862 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 863 | # |
| 864 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 865 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 866 | # a year. |
| 867 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 868 | # if specifying a year by itself or a year and month where the day is not |
| 869 | # significant. |
| 870 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 871 | # month and day. |
| 872 | }, |
| 873 | }, |
| 874 | "description": "A String", # The budget segment description. It can be used to enter Purchase Order |
| 875 | # information for each budget segment and have that information printed on |
| 876 | # the invoices. |
| 877 | # |
| 878 | # Must be UTF-8 encoded with a length of no more than 80 characters. |
| 879 | }, |
| 880 | ], |
| 881 | "automationType": "A String", # The type of automation used to manage bid and budget for |
| 882 | # the insertion order. |
| 883 | # |
| 884 | # If this field is unspecified in creation, the value defaults to |
| 885 | # `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. |
| 886 | }, |
| 887 | "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget |
| 888 | # and bid on inventory. |
| 889 | # |
| 890 | # * For |
| 891 | # CreateInsertionOrder method, |
| 892 | # only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use |
| 893 | # UpdateInsertionOrder method |
| 894 | # and update the status to `ENTITY_STATUS_ACTIVE` after creation. |
| 895 | # * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status |
| 896 | # from any other status. |
| 897 | # * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent |
| 898 | # campaign is not active. |
| 899 | "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. |
| 900 | "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| 901 | # advertiser's currency. |
| 902 | # |
| 903 | # Applicable when the budget is currency based. Must be greater than 0. |
| 904 | # For example, for 1.5 standard unit of the currency, set this field to |
| 905 | # 1500000. |
| 906 | # |
| 907 | # The value assigned will be rounded to whole billable units for the |
| 908 | # relevant currency by the following rules: any positive value less than a |
| 909 | # single billable unit will be rounded up to one billable unit and any |
| 910 | # value larger than a single billable unit will be rounded down to the |
| 911 | # nearest billable value. For example, if the currency's billable unit is |
| 912 | # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| 913 | # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| 914 | # 0.01. |
| 915 | "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| 916 | # |
| 917 | # When automatic budget allocation is enabled at the insertion order via |
| 918 | # auto_budget_allocation, this |
| 919 | # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| 920 | "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| 921 | # spent across the pacing_period. |
| 922 | "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| 923 | # |
| 924 | # Applicable when the budget is impression based. Must be greater than 0. |
| 925 | }, |
| 926 | "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order. |
| 927 | "performanceGoalType": "A String", # Required. The type of the performance goal. |
| 928 | "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. |
| 929 | # |
| 930 | # Applicable when |
| 931 | # performance_goal_type is one of: |
| 932 | # |
| 933 | # * `PERFORMANCE_GOAL_TYPE_CPM` |
| 934 | # * `PERFORMANCE_GOAL_TYPE_CPC` |
| 935 | # * `PERFORMANCE_GOAL_TYPE_CPA` |
| 936 | # * `PERFORMANCE_GOAL_TYPE_CPIAVC` |
| 937 | # |
| 938 | # For example 1500000 represents 1.5 standard units of the currency. |
| 939 | "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. |
| 940 | # |
| 941 | # Applicable when |
| 942 | # performance_goal_type is one of: |
| 943 | # |
| 944 | # * `PERFORMANCE_GOAL_TYPE_CTR` |
| 945 | # * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` |
| 946 | # |
| 947 | # For example, 70000 represents 7% (decimal 0.07). |
| 948 | "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. |
| 949 | # Must be UTF-8 encoded with a length of no more than 100 characters. |
| 950 | # |
| 951 | # Applicable when |
| 952 | # performance_goal_type is set to |
| 953 | # `PERFORMANCE_GOAL_TYPE_OTHER`. |
| 954 | }, |
| 955 | "name": "A String", # Output only. The resource name of the insertion order. |
| 956 | "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. |
| 957 | "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. |
| 958 | "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. |
| 959 | "details": "A String", # Additional details of the entry in string format. |
| 960 | # |
| 961 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 962 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 963 | # The integration code will show up together with the entry in many |
| 964 | # places in the system, for example, reporting. |
| 965 | # |
| 966 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 967 | }, |
| 968 | "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default, |
| 969 | # fixed_bid is set. |
| 970 | # Bid strategy determines the bid price. |
| 971 | "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 |
| 972 | # performance goal. It is to be used only for a line item entity. |
| 973 | # performance goal. |
| 974 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 975 | # will try to meet or beat. |
| 976 | # |
| 977 | # For line item level usage, the value must be one of: |
| 978 | # |
| 979 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 980 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 981 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 982 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 983 | # currency. Must be greater than or equal to a billable unit of the given |
| 984 | # currency. Not applicable when |
| 985 | # performance_goal_type |
| 986 | # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 987 | # |
| 988 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 989 | "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| 990 | # meet or beat, in micros of the advertiser's currency. |
| 991 | # Must be greater than or equal to a billable unit of the given currency and |
| 992 | # smaller or equal to upper bounds. Each |
| 993 | # performance_goal_type |
| 994 | # has its upper bound: |
| 995 | # |
| 996 | # * when |
| 997 | # performance_goal_type |
| 998 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| 999 | # upper bound is 10000.00 USD. |
| 1000 | # * when |
| 1001 | # performance_goal_type |
| 1002 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| 1003 | # upper bound is 1000.00 USD. |
| 1004 | # * when |
| 1005 | # performance_goal_type |
| 1006 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| 1007 | # 1000.00 USD. |
| 1008 | # |
| 1009 | # Example: If set to |
| 1010 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will |
| 1011 | # be based on the probability that each available impression will be |
| 1012 | # viewable. For example, if viewable CPM target is $2 and an impression is |
| 1013 | # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). |
| 1014 | # |
| 1015 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1016 | }, |
| 1017 | "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| 1018 | "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| 1019 | # For insertion order entity, |
| 1020 | # bid_amount_micros should be set as 0. |
| 1021 | # For line item entity, |
| 1022 | # bid_amount_micros must be greater |
| 1023 | # than or equal to billable unit of the given currency and smaller than or |
| 1024 | # equal to the upper limit 1000000000. |
| 1025 | # |
| 1026 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1027 | }, |
| 1028 | "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your |
| 1029 | # performance goal while spending the full budget. |
| 1030 | # |
| 1031 | # At insertion order level, the |
| 1032 | # markup_type of line items |
| 1033 | # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, |
| 1034 | # when |
| 1035 | # performance_goal_type |
| 1036 | # is one of: |
| 1037 | # |
| 1038 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 1039 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 1040 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , |
| 1041 | # |
| 1042 | # the line_item_type |
| 1043 | # of the insertion order line items must be either: |
| 1044 | # |
| 1045 | # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` |
| 1046 | # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , |
| 1047 | # |
| 1048 | # and when |
| 1049 | # performance_goal_type |
| 1050 | # is either: |
| 1051 | # |
| 1052 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` |
| 1053 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` |
| 1054 | # |
| 1055 | # the line_item_type |
| 1056 | # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. |
| 1057 | # performance goal while spending the full budget. |
| 1058 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 1059 | # tries to minimize while spending the full budget. |
| 1060 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| 1061 | # this strategy. |
| 1062 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 1063 | # currency. Must be greater than or equal to a billable unit of the given |
| 1064 | # currency. |
| 1065 | # |
| 1066 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1067 | }, |
| 1068 | }, |
| 1069 | "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. |
| 1070 | # ad during a given time period. |
| 1071 | "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| 1072 | # |
| 1073 | # Applicable when unlimited is `false`. |
| 1074 | "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| 1075 | # last. |
| 1076 | # |
| 1077 | # Applicable when unlimited is `false`. |
| 1078 | # The following restrictions apply based on the value of |
| 1079 | # time_unit: |
| 1080 | # |
| 1081 | # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| 1082 | # default to 1 |
| 1083 | # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| 1084 | # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| 1085 | # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| 1086 | # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| 1087 | # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| 1088 | "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| 1089 | # `true`, the remaining frequency cap fields are not applicable. |
| 1090 | "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| 1091 | # during this period. Must be greater than 0. |
| 1092 | # |
| 1093 | # Applicable when unlimited is `false`. |
| 1094 | }, |
| 1095 | "displayName": "A String", # Required. The display name of the insertion order. |
| 1096 | # |
| 1097 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 1098 | "partnerCosts": [ # The partner costs associated with the insertion order. |
| 1099 | # |
| 1100 | # If absent or empty in |
| 1101 | # CreateInsertionOrder |
| 1102 | # method, the newly created insertion order will inherit partner costs from |
| 1103 | # the partner settings. |
| 1104 | { # Settings that control a partner cost. |
| 1105 | # |
| 1106 | # A partner cost is any type of expense involved in running a campaign, other |
| 1107 | # than the costs of purchasing impressions (which is called the media cost) |
| 1108 | # and using third-party audience segment data (data fee). Some examples of |
| 1109 | # partner costs include the fees for using DV360, a third-party ad server, |
| 1110 | # or a third-party ad serving verification service. |
| 1111 | "costType": "A String", # Required. The type of the partner cost. |
| 1112 | "feeType": "A String", # Required. The fee type for this partner cost. |
| 1113 | "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| 1114 | # |
| 1115 | # Applicable when the fee_type is |
| 1116 | # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| 1117 | # |
| 1118 | # For example: 100 represents 0.1%. |
| 1119 | "invoiceType": "A String", # The invoice type for this partner cost. |
| 1120 | # |
| 1121 | # * Required when cost_type is one of: |
| 1122 | # - `PARTNER_COST_TYPE_ADLOOX` |
| 1123 | # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| 1124 | # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| 1125 | # * Output only for other types. |
| 1126 | "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| 1127 | # |
| 1128 | # Applicable when the fee_type is |
| 1129 | # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| 1130 | # |
| 1131 | # For example, for 1.5 standard unit of the advertiser's currency, set |
| 1132 | # this field to 1500000. |
| 1133 | }, |
| 1134 | ], |
| 1135 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. |
| 1136 | "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. |
| 1137 | # Assigned by the system. |
| 1138 | }</pre> |
| 1139 | </div> |
| 1140 | |
| 1141 | <div class="method"> |
| 1142 | <code class="details" id="list">list(advertiserId, pageToken=None, orderBy=None, pageSize=None, filter=None, x__xgafv=None)</code> |
| 1143 | <pre>Lists insertion orders in an advertiser. |
| 1144 | |
| 1145 | The order is defined by the order_by |
| 1146 | parameter. |
| 1147 | If a filter by |
| 1148 | entity_status is not specified, insertion |
| 1149 | orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results. |
| 1150 | |
| 1151 | Args: |
| 1152 | advertiserId: string, Required. The ID of the advertiser to list insertion orders for. (required) |
| 1153 | pageToken: string, A token identifying a page of results the server should return. |
| 1154 | Typically, this is the value of |
| 1155 | next_page_token returned |
| 1156 | from the previous call to `ListInsertionOrders` method. If not specified, |
| 1157 | the first page of results will be returned. |
| 1158 | orderBy: string, Field by which to sort the list. |
| 1159 | Acceptable values are: |
| 1160 | |
| 1161 | * "displayName" (default) |
| 1162 | * "entityStatus" |
| 1163 | |
| 1164 | The default sorting order is ascending. To specify descending order for |
| 1165 | a field, a suffix "desc" should be added to the field name. Example: |
| 1166 | `displayName desc`. |
| 1167 | pageSize: integer, Requested page size. Must be between `1` and `100`. If unspecified will |
| 1168 | default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value |
| 1169 | is specified. |
| 1170 | filter: string, Allows filtering by insertion order properties. |
| 1171 | |
| 1172 | Supported syntax: |
| 1173 | |
| 1174 | * Filter expressions are made up of one or more restrictions. |
| 1175 | * Restrictions can be combined by `AND` or `OR` logical operators. A |
| 1176 | sequence of restrictions implicitly uses `AND`. |
| 1177 | * A restriction has the form of `{field} {operator} {value}`. |
| 1178 | * The operator must be `EQUALS (=)`. |
| 1179 | * Supported fields: |
| 1180 | - `campaignId` |
| 1181 | - `entityStatus` |
| 1182 | |
| 1183 | Examples: |
| 1184 | |
| 1185 | * All insertion orders under a campaign: `campaignId="1234"` |
| 1186 | * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders |
| 1187 | under an advertiser: |
| 1188 | `(entityStatus="ENTITY_STATUS_ACTIVE" OR |
| 1189 | entityStatus="ENTITY_STATUS_PAUSED")` |
| 1190 | |
| 1191 | The length of this field should be no more than 500 characters. |
| 1192 | x__xgafv: string, V1 error format. |
| 1193 | Allowed values |
| 1194 | 1 - v1 error format |
| 1195 | 2 - v2 error format |
| 1196 | |
| 1197 | Returns: |
| 1198 | An object of the form: |
| 1199 | |
| 1200 | { |
| 1201 | "insertionOrders": [ # The list of insertion orders. |
| 1202 | # |
| 1203 | # This list will be absent if empty. |
| 1204 | { # A single insertion order. |
| 1205 | "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. |
| 1206 | "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or |
| 1207 | # impression based. |
| 1208 | "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify |
| 1209 | # a specific budget for a given period of time an insertion order is running. |
| 1210 | { # Settings that control the budget of a single budget segment. |
| 1211 | "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget |
| 1212 | # segment. |
| 1213 | "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given |
| 1214 | # date_range. |
| 1215 | # The amount is in micros. Must be greater than 0. For example, 500000000 |
| 1216 | # represents 500 standard units of the currency. |
| 1217 | "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved |
| 1218 | # relative to the parent advertiser's time zone. |
| 1219 | # |
| 1220 | # * When creating a new budget segment, both `start_date` and `end_date` |
| 1221 | # must be in the future. |
| 1222 | # * An existing budget segment with a `start_date` in the past has a mutable |
| 1223 | # `end_date` but an immutable `start_date`. |
| 1224 | # * `end_date` must be the `start_date` or later, both before the year 2037. |
| 1225 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value |
| 1226 | # for `year`, `month`, and `day`. |
| 1227 | # and time zone are either specified elsewhere or are not significant. The date |
| 1228 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1229 | # |
| 1230 | # * A full date, with non-zero year, month and day values |
| 1231 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1232 | # * A year on its own, with zero month and day values |
| 1233 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1234 | # |
| 1235 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1236 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1237 | # a year. |
| 1238 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1239 | # if specifying a year by itself or a year and month where the day is not |
| 1240 | # significant. |
| 1241 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1242 | # month and day. |
| 1243 | }, |
| 1244 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value |
| 1245 | # for `year`, `month`, and `day`. |
| 1246 | # and time zone are either specified elsewhere or are not significant. The date |
| 1247 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1248 | # |
| 1249 | # * A full date, with non-zero year, month and day values |
| 1250 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1251 | # * A year on its own, with zero month and day values |
| 1252 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1253 | # |
| 1254 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1255 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1256 | # a year. |
| 1257 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1258 | # if specifying a year by itself or a year and month where the day is not |
| 1259 | # significant. |
| 1260 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1261 | # month and day. |
| 1262 | }, |
| 1263 | }, |
| 1264 | "description": "A String", # The budget segment description. It can be used to enter Purchase Order |
| 1265 | # information for each budget segment and have that information printed on |
| 1266 | # the invoices. |
| 1267 | # |
| 1268 | # Must be UTF-8 encoded with a length of no more than 80 characters. |
| 1269 | }, |
| 1270 | ], |
| 1271 | "automationType": "A String", # The type of automation used to manage bid and budget for |
| 1272 | # the insertion order. |
| 1273 | # |
| 1274 | # If this field is unspecified in creation, the value defaults to |
| 1275 | # `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. |
| 1276 | }, |
| 1277 | "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget |
| 1278 | # and bid on inventory. |
| 1279 | # |
| 1280 | # * For |
| 1281 | # CreateInsertionOrder method, |
| 1282 | # only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use |
| 1283 | # UpdateInsertionOrder method |
| 1284 | # and update the status to `ENTITY_STATUS_ACTIVE` after creation. |
| 1285 | # * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status |
| 1286 | # from any other status. |
| 1287 | # * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent |
| 1288 | # campaign is not active. |
| 1289 | "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. |
| 1290 | "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| 1291 | # advertiser's currency. |
| 1292 | # |
| 1293 | # Applicable when the budget is currency based. Must be greater than 0. |
| 1294 | # For example, for 1.5 standard unit of the currency, set this field to |
| 1295 | # 1500000. |
| 1296 | # |
| 1297 | # The value assigned will be rounded to whole billable units for the |
| 1298 | # relevant currency by the following rules: any positive value less than a |
| 1299 | # single billable unit will be rounded up to one billable unit and any |
| 1300 | # value larger than a single billable unit will be rounded down to the |
| 1301 | # nearest billable value. For example, if the currency's billable unit is |
| 1302 | # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| 1303 | # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| 1304 | # 0.01. |
| 1305 | "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| 1306 | # |
| 1307 | # When automatic budget allocation is enabled at the insertion order via |
| 1308 | # auto_budget_allocation, this |
| 1309 | # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| 1310 | "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| 1311 | # spent across the pacing_period. |
| 1312 | "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| 1313 | # |
| 1314 | # Applicable when the budget is impression based. Must be greater than 0. |
| 1315 | }, |
| 1316 | "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order. |
| 1317 | "performanceGoalType": "A String", # Required. The type of the performance goal. |
| 1318 | "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. |
| 1319 | # |
| 1320 | # Applicable when |
| 1321 | # performance_goal_type is one of: |
| 1322 | # |
| 1323 | # * `PERFORMANCE_GOAL_TYPE_CPM` |
| 1324 | # * `PERFORMANCE_GOAL_TYPE_CPC` |
| 1325 | # * `PERFORMANCE_GOAL_TYPE_CPA` |
| 1326 | # * `PERFORMANCE_GOAL_TYPE_CPIAVC` |
| 1327 | # |
| 1328 | # For example 1500000 represents 1.5 standard units of the currency. |
| 1329 | "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. |
| 1330 | # |
| 1331 | # Applicable when |
| 1332 | # performance_goal_type is one of: |
| 1333 | # |
| 1334 | # * `PERFORMANCE_GOAL_TYPE_CTR` |
| 1335 | # * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` |
| 1336 | # |
| 1337 | # For example, 70000 represents 7% (decimal 0.07). |
| 1338 | "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. |
| 1339 | # Must be UTF-8 encoded with a length of no more than 100 characters. |
| 1340 | # |
| 1341 | # Applicable when |
| 1342 | # performance_goal_type is set to |
| 1343 | # `PERFORMANCE_GOAL_TYPE_OTHER`. |
| 1344 | }, |
| 1345 | "name": "A String", # Output only. The resource name of the insertion order. |
| 1346 | "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. |
| 1347 | "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. |
| 1348 | "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. |
| 1349 | "details": "A String", # Additional details of the entry in string format. |
| 1350 | # |
| 1351 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 1352 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 1353 | # The integration code will show up together with the entry in many |
| 1354 | # places in the system, for example, reporting. |
| 1355 | # |
| 1356 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 1357 | }, |
| 1358 | "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default, |
| 1359 | # fixed_bid is set. |
| 1360 | # Bid strategy determines the bid price. |
| 1361 | "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 |
| 1362 | # performance goal. It is to be used only for a line item entity. |
| 1363 | # performance goal. |
| 1364 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 1365 | # will try to meet or beat. |
| 1366 | # |
| 1367 | # For line item level usage, the value must be one of: |
| 1368 | # |
| 1369 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 1370 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 1371 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 1372 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 1373 | # currency. Must be greater than or equal to a billable unit of the given |
| 1374 | # currency. Not applicable when |
| 1375 | # performance_goal_type |
| 1376 | # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 1377 | # |
| 1378 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1379 | "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| 1380 | # meet or beat, in micros of the advertiser's currency. |
| 1381 | # Must be greater than or equal to a billable unit of the given currency and |
| 1382 | # smaller or equal to upper bounds. Each |
| 1383 | # performance_goal_type |
| 1384 | # has its upper bound: |
| 1385 | # |
| 1386 | # * when |
| 1387 | # performance_goal_type |
| 1388 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| 1389 | # upper bound is 10000.00 USD. |
| 1390 | # * when |
| 1391 | # performance_goal_type |
| 1392 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| 1393 | # upper bound is 1000.00 USD. |
| 1394 | # * when |
| 1395 | # performance_goal_type |
| 1396 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| 1397 | # 1000.00 USD. |
| 1398 | # |
| 1399 | # Example: If set to |
| 1400 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will |
| 1401 | # be based on the probability that each available impression will be |
| 1402 | # viewable. For example, if viewable CPM target is $2 and an impression is |
| 1403 | # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). |
| 1404 | # |
| 1405 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1406 | }, |
| 1407 | "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| 1408 | "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| 1409 | # For insertion order entity, |
| 1410 | # bid_amount_micros should be set as 0. |
| 1411 | # For line item entity, |
| 1412 | # bid_amount_micros must be greater |
| 1413 | # than or equal to billable unit of the given currency and smaller than or |
| 1414 | # equal to the upper limit 1000000000. |
| 1415 | # |
| 1416 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1417 | }, |
| 1418 | "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your |
| 1419 | # performance goal while spending the full budget. |
| 1420 | # |
| 1421 | # At insertion order level, the |
| 1422 | # markup_type of line items |
| 1423 | # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, |
| 1424 | # when |
| 1425 | # performance_goal_type |
| 1426 | # is one of: |
| 1427 | # |
| 1428 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 1429 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 1430 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , |
| 1431 | # |
| 1432 | # the line_item_type |
| 1433 | # of the insertion order line items must be either: |
| 1434 | # |
| 1435 | # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` |
| 1436 | # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , |
| 1437 | # |
| 1438 | # and when |
| 1439 | # performance_goal_type |
| 1440 | # is either: |
| 1441 | # |
| 1442 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` |
| 1443 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` |
| 1444 | # |
| 1445 | # the line_item_type |
| 1446 | # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. |
| 1447 | # performance goal while spending the full budget. |
| 1448 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 1449 | # tries to minimize while spending the full budget. |
| 1450 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| 1451 | # this strategy. |
| 1452 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 1453 | # currency. Must be greater than or equal to a billable unit of the given |
| 1454 | # currency. |
| 1455 | # |
| 1456 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1457 | }, |
| 1458 | }, |
| 1459 | "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. |
| 1460 | # ad during a given time period. |
| 1461 | "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| 1462 | # |
| 1463 | # Applicable when unlimited is `false`. |
| 1464 | "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| 1465 | # last. |
| 1466 | # |
| 1467 | # Applicable when unlimited is `false`. |
| 1468 | # The following restrictions apply based on the value of |
| 1469 | # time_unit: |
| 1470 | # |
| 1471 | # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| 1472 | # default to 1 |
| 1473 | # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| 1474 | # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| 1475 | # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| 1476 | # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| 1477 | # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| 1478 | "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| 1479 | # `true`, the remaining frequency cap fields are not applicable. |
| 1480 | "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| 1481 | # during this period. Must be greater than 0. |
| 1482 | # |
| 1483 | # Applicable when unlimited is `false`. |
| 1484 | }, |
| 1485 | "displayName": "A String", # Required. The display name of the insertion order. |
| 1486 | # |
| 1487 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 1488 | "partnerCosts": [ # The partner costs associated with the insertion order. |
| 1489 | # |
| 1490 | # If absent or empty in |
| 1491 | # CreateInsertionOrder |
| 1492 | # method, the newly created insertion order will inherit partner costs from |
| 1493 | # the partner settings. |
| 1494 | { # Settings that control a partner cost. |
| 1495 | # |
| 1496 | # A partner cost is any type of expense involved in running a campaign, other |
| 1497 | # than the costs of purchasing impressions (which is called the media cost) |
| 1498 | # and using third-party audience segment data (data fee). Some examples of |
| 1499 | # partner costs include the fees for using DV360, a third-party ad server, |
| 1500 | # or a third-party ad serving verification service. |
| 1501 | "costType": "A String", # Required. The type of the partner cost. |
| 1502 | "feeType": "A String", # Required. The fee type for this partner cost. |
| 1503 | "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| 1504 | # |
| 1505 | # Applicable when the fee_type is |
| 1506 | # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| 1507 | # |
| 1508 | # For example: 100 represents 0.1%. |
| 1509 | "invoiceType": "A String", # The invoice type for this partner cost. |
| 1510 | # |
| 1511 | # * Required when cost_type is one of: |
| 1512 | # - `PARTNER_COST_TYPE_ADLOOX` |
| 1513 | # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| 1514 | # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| 1515 | # * Output only for other types. |
| 1516 | "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| 1517 | # |
| 1518 | # Applicable when the fee_type is |
| 1519 | # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| 1520 | # |
| 1521 | # For example, for 1.5 standard unit of the advertiser's currency, set |
| 1522 | # this field to 1500000. |
| 1523 | }, |
| 1524 | ], |
| 1525 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. |
| 1526 | "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. |
| 1527 | # Assigned by the system. |
| 1528 | }, |
| 1529 | ], |
| 1530 | "nextPageToken": "A String", # A token to retrieve the next page of results. |
| 1531 | # Pass this value in the page_token |
| 1532 | # field in the subsequent call to `ListInsertionOrders` method to retrieve |
| 1533 | # the next page of results. |
| 1534 | }</pre> |
| 1535 | </div> |
| 1536 | |
| 1537 | <div class="method"> |
| 1538 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 1539 | <pre>Retrieves the next page of results. |
| 1540 | |
| 1541 | Args: |
| 1542 | previous_request: The request for the previous page. (required) |
| 1543 | previous_response: The response from the request for the previous page. (required) |
| 1544 | |
| 1545 | Returns: |
| 1546 | A request object that you can call 'execute()' on to request the next |
| 1547 | page. Returns None if there are no more items in the collection. |
| 1548 | </pre> |
| 1549 | </div> |
| 1550 | |
| 1551 | <div class="method"> |
| 1552 | <code class="details" id="patch">patch(advertiserId, insertionOrderId, body=None, updateMask=None, x__xgafv=None)</code> |
| 1553 | <pre>Updates an existing insertion order. |
| 1554 | Returns the updated insertion order if successful. |
| 1555 | |
| 1556 | Args: |
| 1557 | advertiserId: string, Output only. The unique ID of the advertiser the insertion order belongs to. (required) |
| 1558 | insertionOrderId: string, Output only. The unique ID of the insertion order. Assigned by the system. (required) |
| 1559 | body: object, The request body. |
| 1560 | The object takes the form of: |
| 1561 | |
| 1562 | { # A single insertion order. |
| 1563 | "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. |
| 1564 | "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or |
| 1565 | # impression based. |
| 1566 | "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify |
| 1567 | # a specific budget for a given period of time an insertion order is running. |
| 1568 | { # Settings that control the budget of a single budget segment. |
| 1569 | "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget |
| 1570 | # segment. |
| 1571 | "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given |
| 1572 | # date_range. |
| 1573 | # The amount is in micros. Must be greater than 0. For example, 500000000 |
| 1574 | # represents 500 standard units of the currency. |
| 1575 | "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved |
| 1576 | # relative to the parent advertiser's time zone. |
| 1577 | # |
| 1578 | # * When creating a new budget segment, both `start_date` and `end_date` |
| 1579 | # must be in the future. |
| 1580 | # * An existing budget segment with a `start_date` in the past has a mutable |
| 1581 | # `end_date` but an immutable `start_date`. |
| 1582 | # * `end_date` must be the `start_date` or later, both before the year 2037. |
| 1583 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value |
| 1584 | # for `year`, `month`, and `day`. |
| 1585 | # and time zone are either specified elsewhere or are not significant. The date |
| 1586 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1587 | # |
| 1588 | # * A full date, with non-zero year, month and day values |
| 1589 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1590 | # * A year on its own, with zero month and day values |
| 1591 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1592 | # |
| 1593 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1594 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1595 | # a year. |
| 1596 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1597 | # if specifying a year by itself or a year and month where the day is not |
| 1598 | # significant. |
| 1599 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1600 | # month and day. |
| 1601 | }, |
| 1602 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value |
| 1603 | # for `year`, `month`, and `day`. |
| 1604 | # and time zone are either specified elsewhere or are not significant. The date |
| 1605 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1606 | # |
| 1607 | # * A full date, with non-zero year, month and day values |
| 1608 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1609 | # * A year on its own, with zero month and day values |
| 1610 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1611 | # |
| 1612 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1613 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1614 | # a year. |
| 1615 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1616 | # if specifying a year by itself or a year and month where the day is not |
| 1617 | # significant. |
| 1618 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1619 | # month and day. |
| 1620 | }, |
| 1621 | }, |
| 1622 | "description": "A String", # The budget segment description. It can be used to enter Purchase Order |
| 1623 | # information for each budget segment and have that information printed on |
| 1624 | # the invoices. |
| 1625 | # |
| 1626 | # Must be UTF-8 encoded with a length of no more than 80 characters. |
| 1627 | }, |
| 1628 | ], |
| 1629 | "automationType": "A String", # The type of automation used to manage bid and budget for |
| 1630 | # the insertion order. |
| 1631 | # |
| 1632 | # If this field is unspecified in creation, the value defaults to |
| 1633 | # `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. |
| 1634 | }, |
| 1635 | "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget |
| 1636 | # and bid on inventory. |
| 1637 | # |
| 1638 | # * For |
| 1639 | # CreateInsertionOrder method, |
| 1640 | # only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use |
| 1641 | # UpdateInsertionOrder method |
| 1642 | # and update the status to `ENTITY_STATUS_ACTIVE` after creation. |
| 1643 | # * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status |
| 1644 | # from any other status. |
| 1645 | # * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent |
| 1646 | # campaign is not active. |
| 1647 | "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. |
| 1648 | "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| 1649 | # advertiser's currency. |
| 1650 | # |
| 1651 | # Applicable when the budget is currency based. Must be greater than 0. |
| 1652 | # For example, for 1.5 standard unit of the currency, set this field to |
| 1653 | # 1500000. |
| 1654 | # |
| 1655 | # The value assigned will be rounded to whole billable units for the |
| 1656 | # relevant currency by the following rules: any positive value less than a |
| 1657 | # single billable unit will be rounded up to one billable unit and any |
| 1658 | # value larger than a single billable unit will be rounded down to the |
| 1659 | # nearest billable value. For example, if the currency's billable unit is |
| 1660 | # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| 1661 | # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| 1662 | # 0.01. |
| 1663 | "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| 1664 | # |
| 1665 | # When automatic budget allocation is enabled at the insertion order via |
| 1666 | # auto_budget_allocation, this |
| 1667 | # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| 1668 | "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| 1669 | # spent across the pacing_period. |
| 1670 | "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| 1671 | # |
| 1672 | # Applicable when the budget is impression based. Must be greater than 0. |
| 1673 | }, |
| 1674 | "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order. |
| 1675 | "performanceGoalType": "A String", # Required. The type of the performance goal. |
| 1676 | "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. |
| 1677 | # |
| 1678 | # Applicable when |
| 1679 | # performance_goal_type is one of: |
| 1680 | # |
| 1681 | # * `PERFORMANCE_GOAL_TYPE_CPM` |
| 1682 | # * `PERFORMANCE_GOAL_TYPE_CPC` |
| 1683 | # * `PERFORMANCE_GOAL_TYPE_CPA` |
| 1684 | # * `PERFORMANCE_GOAL_TYPE_CPIAVC` |
| 1685 | # |
| 1686 | # For example 1500000 represents 1.5 standard units of the currency. |
| 1687 | "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. |
| 1688 | # |
| 1689 | # Applicable when |
| 1690 | # performance_goal_type is one of: |
| 1691 | # |
| 1692 | # * `PERFORMANCE_GOAL_TYPE_CTR` |
| 1693 | # * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` |
| 1694 | # |
| 1695 | # For example, 70000 represents 7% (decimal 0.07). |
| 1696 | "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. |
| 1697 | # Must be UTF-8 encoded with a length of no more than 100 characters. |
| 1698 | # |
| 1699 | # Applicable when |
| 1700 | # performance_goal_type is set to |
| 1701 | # `PERFORMANCE_GOAL_TYPE_OTHER`. |
| 1702 | }, |
| 1703 | "name": "A String", # Output only. The resource name of the insertion order. |
| 1704 | "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. |
| 1705 | "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. |
| 1706 | "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. |
| 1707 | "details": "A String", # Additional details of the entry in string format. |
| 1708 | # |
| 1709 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 1710 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 1711 | # The integration code will show up together with the entry in many |
| 1712 | # places in the system, for example, reporting. |
| 1713 | # |
| 1714 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 1715 | }, |
| 1716 | "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default, |
| 1717 | # fixed_bid is set. |
| 1718 | # Bid strategy determines the bid price. |
| 1719 | "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 |
| 1720 | # performance goal. It is to be used only for a line item entity. |
| 1721 | # performance goal. |
| 1722 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 1723 | # will try to meet or beat. |
| 1724 | # |
| 1725 | # For line item level usage, the value must be one of: |
| 1726 | # |
| 1727 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 1728 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 1729 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 1730 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 1731 | # currency. Must be greater than or equal to a billable unit of the given |
| 1732 | # currency. Not applicable when |
| 1733 | # performance_goal_type |
| 1734 | # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 1735 | # |
| 1736 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1737 | "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| 1738 | # meet or beat, in micros of the advertiser's currency. |
| 1739 | # Must be greater than or equal to a billable unit of the given currency and |
| 1740 | # smaller or equal to upper bounds. Each |
| 1741 | # performance_goal_type |
| 1742 | # has its upper bound: |
| 1743 | # |
| 1744 | # * when |
| 1745 | # performance_goal_type |
| 1746 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| 1747 | # upper bound is 10000.00 USD. |
| 1748 | # * when |
| 1749 | # performance_goal_type |
| 1750 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| 1751 | # upper bound is 1000.00 USD. |
| 1752 | # * when |
| 1753 | # performance_goal_type |
| 1754 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| 1755 | # 1000.00 USD. |
| 1756 | # |
| 1757 | # Example: If set to |
| 1758 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will |
| 1759 | # be based on the probability that each available impression will be |
| 1760 | # viewable. For example, if viewable CPM target is $2 and an impression is |
| 1761 | # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). |
| 1762 | # |
| 1763 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1764 | }, |
| 1765 | "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| 1766 | "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| 1767 | # For insertion order entity, |
| 1768 | # bid_amount_micros should be set as 0. |
| 1769 | # For line item entity, |
| 1770 | # bid_amount_micros must be greater |
| 1771 | # than or equal to billable unit of the given currency and smaller than or |
| 1772 | # equal to the upper limit 1000000000. |
| 1773 | # |
| 1774 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1775 | }, |
| 1776 | "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your |
| 1777 | # performance goal while spending the full budget. |
| 1778 | # |
| 1779 | # At insertion order level, the |
| 1780 | # markup_type of line items |
| 1781 | # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, |
| 1782 | # when |
| 1783 | # performance_goal_type |
| 1784 | # is one of: |
| 1785 | # |
| 1786 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 1787 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 1788 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , |
| 1789 | # |
| 1790 | # the line_item_type |
| 1791 | # of the insertion order line items must be either: |
| 1792 | # |
| 1793 | # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` |
| 1794 | # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , |
| 1795 | # |
| 1796 | # and when |
| 1797 | # performance_goal_type |
| 1798 | # is either: |
| 1799 | # |
| 1800 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` |
| 1801 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` |
| 1802 | # |
| 1803 | # the line_item_type |
| 1804 | # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. |
| 1805 | # performance goal while spending the full budget. |
| 1806 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 1807 | # tries to minimize while spending the full budget. |
| 1808 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| 1809 | # this strategy. |
| 1810 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 1811 | # currency. Must be greater than or equal to a billable unit of the given |
| 1812 | # currency. |
| 1813 | # |
| 1814 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 1815 | }, |
| 1816 | }, |
| 1817 | "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. |
| 1818 | # ad during a given time period. |
| 1819 | "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| 1820 | # |
| 1821 | # Applicable when unlimited is `false`. |
| 1822 | "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| 1823 | # last. |
| 1824 | # |
| 1825 | # Applicable when unlimited is `false`. |
| 1826 | # The following restrictions apply based on the value of |
| 1827 | # time_unit: |
| 1828 | # |
| 1829 | # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| 1830 | # default to 1 |
| 1831 | # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| 1832 | # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| 1833 | # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| 1834 | # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| 1835 | # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| 1836 | "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| 1837 | # `true`, the remaining frequency cap fields are not applicable. |
| 1838 | "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| 1839 | # during this period. Must be greater than 0. |
| 1840 | # |
| 1841 | # Applicable when unlimited is `false`. |
| 1842 | }, |
| 1843 | "displayName": "A String", # Required. The display name of the insertion order. |
| 1844 | # |
| 1845 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 1846 | "partnerCosts": [ # The partner costs associated with the insertion order. |
| 1847 | # |
| 1848 | # If absent or empty in |
| 1849 | # CreateInsertionOrder |
| 1850 | # method, the newly created insertion order will inherit partner costs from |
| 1851 | # the partner settings. |
| 1852 | { # Settings that control a partner cost. |
| 1853 | # |
| 1854 | # A partner cost is any type of expense involved in running a campaign, other |
| 1855 | # than the costs of purchasing impressions (which is called the media cost) |
| 1856 | # and using third-party audience segment data (data fee). Some examples of |
| 1857 | # partner costs include the fees for using DV360, a third-party ad server, |
| 1858 | # or a third-party ad serving verification service. |
| 1859 | "costType": "A String", # Required. The type of the partner cost. |
| 1860 | "feeType": "A String", # Required. The fee type for this partner cost. |
| 1861 | "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| 1862 | # |
| 1863 | # Applicable when the fee_type is |
| 1864 | # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| 1865 | # |
| 1866 | # For example: 100 represents 0.1%. |
| 1867 | "invoiceType": "A String", # The invoice type for this partner cost. |
| 1868 | # |
| 1869 | # * Required when cost_type is one of: |
| 1870 | # - `PARTNER_COST_TYPE_ADLOOX` |
| 1871 | # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| 1872 | # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| 1873 | # * Output only for other types. |
| 1874 | "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| 1875 | # |
| 1876 | # Applicable when the fee_type is |
| 1877 | # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| 1878 | # |
| 1879 | # For example, for 1.5 standard unit of the advertiser's currency, set |
| 1880 | # this field to 1500000. |
| 1881 | }, |
| 1882 | ], |
| 1883 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. |
| 1884 | "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. |
| 1885 | # Assigned by the system. |
| 1886 | } |
| 1887 | |
| 1888 | updateMask: string, Required. The mask to control which fields to update. |
| 1889 | x__xgafv: string, V1 error format. |
| 1890 | Allowed values |
| 1891 | 1 - v1 error format |
| 1892 | 2 - v2 error format |
| 1893 | |
| 1894 | Returns: |
| 1895 | An object of the form: |
| 1896 | |
| 1897 | { # A single insertion order. |
| 1898 | "budget": { # Settings that control how insertion order budget is allocated. # Required. The budget allocation settings of the insertion order. |
| 1899 | "budgetUnit": "A String", # Required. Immutable. The budget unit specifies whether the budget is currency based or |
| 1900 | # impression based. |
| 1901 | "budgetSegments": [ # Required. The list of budget segments. Use a budget segment to specify |
| 1902 | # a specific budget for a given period of time an insertion order is running. |
| 1903 | { # Settings that control the budget of a single budget segment. |
| 1904 | "campaignBudgetId": "A String", # The ID of the campaign budget linked to this insertion order budget |
| 1905 | # segment. |
| 1906 | "budgetAmountMicros": "A String", # Required. The budget amount the insertion order will spend for the given |
| 1907 | # date_range. |
| 1908 | # The amount is in micros. Must be greater than 0. For example, 500000000 |
| 1909 | # represents 500 standard units of the currency. |
| 1910 | "dateRange": { # A date range. # Required. The start and end date settings of the budget segment. They are resolved |
| 1911 | # relative to the parent advertiser's time zone. |
| 1912 | # |
| 1913 | # * When creating a new budget segment, both `start_date` and `end_date` |
| 1914 | # must be in the future. |
| 1915 | # * An existing budget segment with a `start_date` in the past has a mutable |
| 1916 | # `end_date` but an immutable `start_date`. |
| 1917 | # * `end_date` must be the `start_date` or later, both before the year 2037. |
| 1918 | "endDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The upper bound of the date range, inclusive. Must specify a positive value |
| 1919 | # for `year`, `month`, and `day`. |
| 1920 | # and time zone are either specified elsewhere or are not significant. The date |
| 1921 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1922 | # |
| 1923 | # * A full date, with non-zero year, month and day values |
| 1924 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1925 | # * A year on its own, with zero month and day values |
| 1926 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1927 | # |
| 1928 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1929 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1930 | # a year. |
| 1931 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1932 | # if specifying a year by itself or a year and month where the day is not |
| 1933 | # significant. |
| 1934 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1935 | # month and day. |
| 1936 | }, |
| 1937 | "startDate": { # Represents a whole or partial calendar date, e.g. a birthday. The time of day # The lower bound of the date range, inclusive. Must specify a positive value |
| 1938 | # for `year`, `month`, and `day`. |
| 1939 | # and time zone are either specified elsewhere or are not significant. The date |
| 1940 | # is relative to the Proleptic Gregorian Calendar. This can represent: |
| 1941 | # |
| 1942 | # * A full date, with non-zero year, month and day values |
| 1943 | # * A month and day value, with a zero year, e.g. an anniversary |
| 1944 | # * A year on its own, with zero month and day values |
| 1945 | # * A year and month value, with a zero day, e.g. a credit card expiration date |
| 1946 | # |
| 1947 | # Related types are google.type.TimeOfDay and `google.protobuf.Timestamp`. |
| 1948 | "year": 42, # Year of date. Must be from 1 to 9999, or 0 if specifying a date without |
| 1949 | # a year. |
| 1950 | "day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month, or 0 |
| 1951 | # if specifying a year by itself or a year and month where the day is not |
| 1952 | # significant. |
| 1953 | "month": 42, # Month of year. Must be from 1 to 12, or 0 if specifying a year without a |
| 1954 | # month and day. |
| 1955 | }, |
| 1956 | }, |
| 1957 | "description": "A String", # The budget segment description. It can be used to enter Purchase Order |
| 1958 | # information for each budget segment and have that information printed on |
| 1959 | # the invoices. |
| 1960 | # |
| 1961 | # Must be UTF-8 encoded with a length of no more than 80 characters. |
| 1962 | }, |
| 1963 | ], |
| 1964 | "automationType": "A String", # The type of automation used to manage bid and budget for |
| 1965 | # the insertion order. |
| 1966 | # |
| 1967 | # If this field is unspecified in creation, the value defaults to |
| 1968 | # `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. |
| 1969 | }, |
| 1970 | "entityStatus": "A String", # Required. Controls whether or not the insertion order can spend its budget |
| 1971 | # and bid on inventory. |
| 1972 | # |
| 1973 | # * For |
| 1974 | # CreateInsertionOrder method, |
| 1975 | # only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use |
| 1976 | # UpdateInsertionOrder method |
| 1977 | # and update the status to `ENTITY_STATUS_ACTIVE` after creation. |
| 1978 | # * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status |
| 1979 | # from any other status. |
| 1980 | # * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent |
| 1981 | # campaign is not active. |
| 1982 | "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the insertion order. |
| 1983 | "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of |
| 1984 | # advertiser's currency. |
| 1985 | # |
| 1986 | # Applicable when the budget is currency based. Must be greater than 0. |
| 1987 | # For example, for 1.5 standard unit of the currency, set this field to |
| 1988 | # 1500000. |
| 1989 | # |
| 1990 | # The value assigned will be rounded to whole billable units for the |
| 1991 | # relevant currency by the following rules: any positive value less than a |
| 1992 | # single billable unit will be rounded up to one billable unit and any |
| 1993 | # value larger than a single billable unit will be rounded down to the |
| 1994 | # nearest billable value. For example, if the currency's billable unit is |
| 1995 | # 0.01, and this field is set to 10257770, it will round down to 10250000, |
| 1996 | # a value of 10.25. If set to 505, it will round up to 10000, a value of |
| 1997 | # 0.01. |
| 1998 | "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. |
| 1999 | # |
| 2000 | # When automatic budget allocation is enabled at the insertion order via |
| 2001 | # auto_budget_allocation, this |
| 2002 | # field is output only and defaults to `PACING_PERIOD_FLIGHT`. |
| 2003 | "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be |
| 2004 | # spent across the pacing_period. |
| 2005 | "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. |
| 2006 | # |
| 2007 | # Applicable when the budget is impression based. Must be greater than 0. |
| 2008 | }, |
| 2009 | "performanceGoal": { # Settings that control the performance goal of a campaign or insertion order. # Required. Performance goal of the insertion order. |
| 2010 | "performanceGoalType": "A String", # Required. The type of the performance goal. |
| 2011 | "performanceGoalAmountMicros": "A String", # The goal amount, in micros of the advertiser's currency. |
| 2012 | # |
| 2013 | # Applicable when |
| 2014 | # performance_goal_type is one of: |
| 2015 | # |
| 2016 | # * `PERFORMANCE_GOAL_TYPE_CPM` |
| 2017 | # * `PERFORMANCE_GOAL_TYPE_CPC` |
| 2018 | # * `PERFORMANCE_GOAL_TYPE_CPA` |
| 2019 | # * `PERFORMANCE_GOAL_TYPE_CPIAVC` |
| 2020 | # |
| 2021 | # For example 1500000 represents 1.5 standard units of the currency. |
| 2022 | "performanceGoalPercentageMicros": "A String", # The decimal representation of the goal percentage in micros. |
| 2023 | # |
| 2024 | # Applicable when |
| 2025 | # performance_goal_type is one of: |
| 2026 | # |
| 2027 | # * `PERFORMANCE_GOAL_TYPE_CTR` |
| 2028 | # * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` |
| 2029 | # |
| 2030 | # For example, 70000 represents 7% (decimal 0.07). |
| 2031 | "performanceGoalString": "A String", # A key performance indicator (KPI) string, which can be empty. |
| 2032 | # Must be UTF-8 encoded with a length of no more than 100 characters. |
| 2033 | # |
| 2034 | # Applicable when |
| 2035 | # performance_goal_type is set to |
| 2036 | # `PERFORMANCE_GOAL_TYPE_OTHER`. |
| 2037 | }, |
| 2038 | "name": "A String", # Output only. The resource name of the insertion order. |
| 2039 | "campaignId": "A String", # Required. Immutable. The unique ID of the campaign that the insertion order belongs to. |
| 2040 | "insertionOrderId": "A String", # Output only. The unique ID of the insertion order. Assigned by the system. |
| 2041 | "integrationDetails": { # Integration details of an entry. # Additional integration details of the insertion order. |
| 2042 | "details": "A String", # Additional details of the entry in string format. |
| 2043 | # |
| 2044 | # Must be UTF-8 encoded with a length of no more than 1000 characters. |
| 2045 | "integrationCode": "A String", # An external identifier to be associated with the entry. |
| 2046 | # The integration code will show up together with the entry in many |
| 2047 | # places in the system, for example, reporting. |
| 2048 | # |
| 2049 | # Must be UTF-8 encoded with a length of no more than 500 characters. |
| 2050 | }, |
| 2051 | "bidStrategy": { # Settings that control the bid strategy. # Optional. The bidding strategy of the insertion order. By default, |
| 2052 | # fixed_bid is set. |
| 2053 | # Bid strategy determines the bid price. |
| 2054 | "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 |
| 2055 | # performance goal. It is to be used only for a line item entity. |
| 2056 | # performance goal. |
| 2057 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 2058 | # will try to meet or beat. |
| 2059 | # |
| 2060 | # For line item level usage, the value must be one of: |
| 2061 | # |
| 2062 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 2063 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 2064 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 2065 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 2066 | # currency. Must be greater than or equal to a billable unit of the given |
| 2067 | # currency. Not applicable when |
| 2068 | # performance_goal_type |
| 2069 | # is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. |
| 2070 | # |
| 2071 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 2072 | "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to |
| 2073 | # meet or beat, in micros of the advertiser's currency. |
| 2074 | # Must be greater than or equal to a billable unit of the given currency and |
| 2075 | # smaller or equal to upper bounds. Each |
| 2076 | # performance_goal_type |
| 2077 | # has its upper bound: |
| 2078 | # |
| 2079 | # * when |
| 2080 | # performance_goal_type |
| 2081 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, |
| 2082 | # upper bound is 10000.00 USD. |
| 2083 | # * when |
| 2084 | # performance_goal_type |
| 2085 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, |
| 2086 | # upper bound is 1000.00 USD. |
| 2087 | # * when |
| 2088 | # performance_goal_type |
| 2089 | # is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is |
| 2090 | # 1000.00 USD. |
| 2091 | # |
| 2092 | # Example: If set to |
| 2093 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will |
| 2094 | # be based on the probability that each available impression will be |
| 2095 | # viewable. For example, if viewable CPM target is $2 and an impression is |
| 2096 | # 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). |
| 2097 | # |
| 2098 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 2099 | }, |
| 2100 | "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. |
| 2101 | "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. |
| 2102 | # For insertion order entity, |
| 2103 | # bid_amount_micros should be set as 0. |
| 2104 | # For line item entity, |
| 2105 | # bid_amount_micros must be greater |
| 2106 | # than or equal to billable unit of the given currency and smaller than or |
| 2107 | # equal to the upper limit 1000000000. |
| 2108 | # |
| 2109 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 2110 | }, |
| 2111 | "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified # A strategy that automatically adjusts the bid to optimize to your |
| 2112 | # performance goal while spending the full budget. |
| 2113 | # |
| 2114 | # At insertion order level, the |
| 2115 | # markup_type of line items |
| 2116 | # cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, |
| 2117 | # when |
| 2118 | # performance_goal_type |
| 2119 | # is one of: |
| 2120 | # |
| 2121 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` |
| 2122 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` |
| 2123 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , |
| 2124 | # |
| 2125 | # the line_item_type |
| 2126 | # of the insertion order line items must be either: |
| 2127 | # |
| 2128 | # * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` |
| 2129 | # * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , |
| 2130 | # |
| 2131 | # and when |
| 2132 | # performance_goal_type |
| 2133 | # is either: |
| 2134 | # |
| 2135 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` |
| 2136 | # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` |
| 2137 | # |
| 2138 | # the line_item_type |
| 2139 | # of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`. |
| 2140 | # performance goal while spending the full budget. |
| 2141 | "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy |
| 2142 | # tries to minimize while spending the full budget. |
| 2143 | # `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for |
| 2144 | # this strategy. |
| 2145 | "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's |
| 2146 | # currency. Must be greater than or equal to a billable unit of the given |
| 2147 | # currency. |
| 2148 | # |
| 2149 | # For example, 1500000 represents 1.5 standard units of the currency. |
| 2150 | }, |
| 2151 | }, |
| 2152 | "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. |
| 2153 | # ad during a given time period. |
| 2154 | "timeUnit": "A String", # The time unit in which the frequency cap will be applied. |
| 2155 | # |
| 2156 | # Applicable when unlimited is `false`. |
| 2157 | "timeUnitCount": 42, # The number of time_unit the frequency cap will |
| 2158 | # last. |
| 2159 | # |
| 2160 | # Applicable when unlimited is `false`. |
| 2161 | # The following restrictions apply based on the value of |
| 2162 | # time_unit: |
| 2163 | # |
| 2164 | # * `TIME_UNIT_LIFETIME` - this field is output only and will |
| 2165 | # default to 1 |
| 2166 | # * `TIME_UNIT_MONTHS` - must be between 1 and 2 |
| 2167 | # * `TIME_UNIT_WEEKS` - must be between 1 and 4 |
| 2168 | # * `TIME_UNIT_DAYS` - must be between 1 and 6 |
| 2169 | # * `TIME_UNIT_HOURS` - must be between 1 and 23 |
| 2170 | # * `TIME_UNIT_MINUTES` - must be between 1 and 59 |
| 2171 | "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to |
| 2172 | # `true`, the remaining frequency cap fields are not applicable. |
| 2173 | "maxImpressions": 42, # The maximum number of times a user may be shown with the same ad |
| 2174 | # during this period. Must be greater than 0. |
| 2175 | # |
| 2176 | # Applicable when unlimited is `false`. |
| 2177 | }, |
| 2178 | "displayName": "A String", # Required. The display name of the insertion order. |
| 2179 | # |
| 2180 | # Must be UTF-8 encoded with a maximum size of 240 bytes. |
| 2181 | "partnerCosts": [ # The partner costs associated with the insertion order. |
| 2182 | # |
| 2183 | # If absent or empty in |
| 2184 | # CreateInsertionOrder |
| 2185 | # method, the newly created insertion order will inherit partner costs from |
| 2186 | # the partner settings. |
| 2187 | { # Settings that control a partner cost. |
| 2188 | # |
| 2189 | # A partner cost is any type of expense involved in running a campaign, other |
| 2190 | # than the costs of purchasing impressions (which is called the media cost) |
| 2191 | # and using third-party audience segment data (data fee). Some examples of |
| 2192 | # partner costs include the fees for using DV360, a third-party ad server, |
| 2193 | # or a third-party ad serving verification service. |
| 2194 | "costType": "A String", # Required. The type of the partner cost. |
| 2195 | "feeType": "A String", # Required. The fee type for this partner cost. |
| 2196 | "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). |
| 2197 | # |
| 2198 | # Applicable when the fee_type is |
| 2199 | # `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. |
| 2200 | # |
| 2201 | # For example: 100 represents 0.1%. |
| 2202 | "invoiceType": "A String", # The invoice type for this partner cost. |
| 2203 | # |
| 2204 | # * Required when cost_type is one of: |
| 2205 | # - `PARTNER_COST_TYPE_ADLOOX` |
| 2206 | # - `PARTNER_COST_TYPE_DOUBLE_VERIFY` |
| 2207 | # - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. |
| 2208 | # * Output only for other types. |
| 2209 | "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. |
| 2210 | # |
| 2211 | # Applicable when the fee_type is |
| 2212 | # `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. |
| 2213 | # |
| 2214 | # For example, for 1.5 standard unit of the advertiser's currency, set |
| 2215 | # this field to 1500000. |
| 2216 | }, |
| 2217 | ], |
| 2218 | "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. |
| 2219 | "updateTime": "A String", # Output only. The timestamp when the insertion order was last updated. |
| 2220 | # Assigned by the system. |
| 2221 | }</pre> |
| 2222 | </div> |
| 2223 | |
| 2224 | </body></html> |