--- title: "PATCH /v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}" method: PATCH path: "/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}" tags: ["advertisers"] --- # PATCH /v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId} `PATCH /v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}` Updates an existing insertion order. Returns the updated insertion order if successful. ## Path parameters - `advertiserId` string, required - `insertionOrderId` string, required ## Query parameters - `updateMask` string ## Request body - InsertionOrder — A single insertion order. - `entityStatus` 'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION' — Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active. - `optimizationObjective` 'OPTIMIZATION_OBJECTIVE_UNSPECIFIED' | 'CONVERSION' | 'CLICK' | 'BRAND_AWARENESS' | 'CUSTOM' | 'NO_OBJECTIVE' — Optional. Required. The optimization objective of the insertion order. - `kpi` Kpi — Settings that control the key performance indicator, or KPI, of an insertion order. - `kpiAmountMicros` string, int64 — The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency. - `kpiType` 'KPI_TYPE_UNSPECIFIED' | 'KPI_TYPE_CPM' | 'KPI_TYPE_CPC' | 'KPI_TYPE_CPA' | 'KPI_TYPE_CTR' | 'KPI_TYPE_VIEWABILITY' | 'KPI_TYPE_CPIAVC' | 'KPI_TYPE_CPE' | 'KPI_TYPE_CPV' | 'KPI_TYPE_CLICK_CVR' | 'KPI_TYPE_IMPRESSION_CVR' | 'KPI_TYPE_VCPM' | 'KPI_TYPE_VTR' | 'KPI_TYPE_AUDIO_COMPLETION_RATE' | 'KPI_TYPE_VIDEO_COMPLETION_RATE' | 'KPI_TYPE_CPCL' | 'KPI_TYPE_CPCV' | 'KPI_TYPE_TOS10' | 'KPI_TYPE_MAXIMIZE_PACING' | 'KPI_TYPE_CUSTOM_IMPRESSION_VALUE_OVER_COST' | 'KPI_TYPE_OTHER' — Required. The type of KPI. - `kpiPercentageMicros` string, int64 — The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07). - `kpiString` string — A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`. - `kpiAlgorithmId` string, int64 — Optional. Custom Bidding Algorithm ID associated with KPI_CUSTOM_IMPRESSION_VALUE_OVER_COST. This field is ignored if the proper KPI is not selected. - `reservationType` 'RESERVATION_TYPE_UNSPECIFIED' | 'RESERVATION_TYPE_NOT_GUARANTEED' | 'RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED' | 'RESERVATION_TYPE_TAG_GUARANTEED' | 'RESERVATION_TYPE_PETRA_VIRAL' | 'RESERVATION_TYPE_INSTANT_RESERVE' — Output only. The reservation type of the insertion order. - `insertionOrderType` 'INSERTION_ORDER_TYPE_UNSPECIFIED' | 'RTB' | 'OVER_THE_TOP' — Optional. The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. - `partnerCosts` PartnerCost[] — Optional. The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. - `costType` 'PARTNER_COST_TYPE_UNSPECIFIED' | 'PARTNER_COST_TYPE_ADLOOX' | 'PARTNER_COST_TYPE_ADLOOX_PREBID' | 'PARTNER_COST_TYPE_ADSAFE' | 'PARTNER_COST_TYPE_ADXPOSE' | 'PARTNER_COST_TYPE_AGGREGATE_KNOWLEDGE' | 'PARTNER_COST_TYPE_AGENCY_TRADING_DESK' | 'PARTNER_COST_TYPE_DV360_FEE' | 'PARTNER_COST_TYPE_COMSCORE_VCE' | 'PARTNER_COST_TYPE_DATA_MANAGEMENT_PLATFORM' | 'PARTNER_COST_TYPE_DEFAULT' | 'PARTNER_COST_TYPE_DOUBLE_VERIFY' | 'PARTNER_COST_TYPE_DOUBLE_VERIFY_PREBID' | 'PARTNER_COST_TYPE_EVIDON' | 'PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO' | 'PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_PREBID' | 'PARTNER_COST_TYPE_MEDIA_COST_DATA' | 'PARTNER_COST_TYPE_MOAT_VIDEO' | 'PARTNER_COST_TYPE_NIELSEN_DAR' | 'PARTNER_COST_TYPE_SHOP_LOCAL' | 'PARTNER_COST_TYPE_TERACENT' | 'PARTNER_COST_TYPE_THIRD_PARTY_AD_SERVER' | 'PARTNER_COST_TYPE_TRUST_METRICS' | 'PARTNER_COST_TYPE_VIZU' | 'PARTNER_COST_TYPE_CUSTOM_FEE_1' | 'PARTNER_COST_TYPE_CUSTOM_FEE_2' | 'PARTNER_COST_TYPE_CUSTOM_FEE_3' | 'PARTNER_COST_TYPE_CUSTOM_FEE_4' | 'PARTNER_COST_TYPE_CUSTOM_FEE_5' | 'PARTNER_COST_TYPE_SCIBIDS_FEE' — Required. The type of the partner cost. - `feeAmount` string, int64 — The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000. - `invoiceType` 'PARTNER_COST_INVOICE_TYPE_UNSPECIFIED' | 'PARTNER_COST_INVOICE_TYPE_DV360' | 'PARTNER_COST_INVOICE_TYPE_PARTNER' — The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types. - `feeType` 'PARTNER_COST_FEE_TYPE_UNSPECIFIED' | 'PARTNER_COST_FEE_TYPE_CPM_FEE' | 'PARTNER_COST_FEE_TYPE_MEDIA_FEE' — Required. The fee type for this partner cost. - `feePercentageMillis` string, int64 — The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%. - `name` string — Output only. The resource name of the insertion order. - `displayName` string — Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. - `updateTime` string, google-datetime — Output only. The timestamp when the insertion order was last updated. Assigned by the system. - `campaignId` string, int64 — Required. Immutable. The unique ID of the campaign that the insertion order belongs to. - `pacing` Pacing — Settings that control the rate at which a budget is spent. - `pacingPeriod` 'PACING_PERIOD_UNSPECIFIED' | 'PACING_PERIOD_DAILY' | 'PACING_PERIOD_FLIGHT' — Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. - `dailyMaxMicros` string, int64 — Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01. - `pacingType` 'PACING_TYPE_UNSPECIFIED' | 'PACING_TYPE_AHEAD' | 'PACING_TYPE_ASAP' | 'PACING_TYPE_EVEN' — Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders. - `dailyMaxImpressions` string, int64 — Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. - `bidStrategy` BiddingStrategy — Settings that control the bid strategy. Bid strategy determines the bid price. - `fixedBid` FixedBidStrategy — A strategy that uses a fixed bidding price. - `bidAmountMicros` string, int64 — The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. - `performanceGoalAutoBid` PerformanceGoalBidStrategy — A strategy that automatically adjusts the bid to meet or beat a specified performance goal. - `performanceGoalAmountMicros` string, int64 — Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value. - `customBiddingAlgorithmId` string, int64 — The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. - `performanceGoalType` 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH' — Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. - `maxAverageCpmBidAmountMicros` string, int64 — The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency. - `maximizeSpendAutoBid` MaximizeSpendBidStrategy — A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. - `raiseBidForDeals` boolean — Whether the strategy takes deal floor prices into account. - `customBiddingAlgorithmId` string, int64 — The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. - `maxAverageCpmBidAmountMicros` string, int64 — The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. - `performanceGoalType` 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_UNSPECIFIED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED' | 'BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH' — Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. - `demandGenBid` DemandGenBiddingStrategy — Settings that control the bid strategy for Demand Gen resources. - `value` string, int64 — Optional. The value used by the bidding strategy. This can be set when assigned to line items or ad groups. This field is only applicable for the following strategy types: * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC` * `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS` Value of this field is in micros of the advertiser's currency or ROAS value. For example, 1000000 represents 1.0 standard units of the currency or 100% ROAS value. If not using an applicable strategy, the value of this field will be 0. - `effectiveBiddingValueSource` 'BIDDING_SOURCE_UNSPECIFIED' | 'BIDDING_SOURCE_LINE_ITEM' | 'BIDDING_SOURCE_AD_GROUP' — Output only. Source of the effective bidding value. - `type` 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_UNSPECIFIED' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_MAXIMIZE_CLICKS' | 'DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPC' — Optional. The type of the bidding strategy. This can only be set when assigned to a line item. Ad groups will inherit this value from their line item. - `effectiveBiddingValue` string, int64 — Output only. The value effectively used by the bidding strategy. This field will be the same as value if set. If value is not set and the strategy is assigned to an ad group, this field will be inherited from the line item's bidding strategy. If type is not `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_CPA` or `DEMAND_GEN_BIDDING_STRATEGY_TYPE_TARGET_ROAS`, this field will be 0. - `youtubeAndPartnersBid` YoutubeAndPartnersBiddingStrategy — Settings that control the bid strategy for YouTube and Partners resources. - `type` 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_UNSPECIFIED' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS' | 'YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE' — The type of the bidding strategy. - `value` string, int64 — The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0. - `adGroupEffectiveTargetCpaValue` string, int64 — Output only. The effective target CPA for ad group, in micros of advertiser's currency. - `adGroupEffectiveTargetCpaSource` 'BIDDING_SOURCE_UNSPECIFIED' | 'BIDDING_SOURCE_LINE_ITEM' | 'BIDDING_SOURCE_AD_GROUP' — Output only. Source of the effective target CPA value for ad group. - `frequencyCap` FrequencyCap — Settings that control the number of times a user may be shown with the same ad during a given time period. - `maxViews` integer — Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set. - `unlimited` boolean — Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. - `timeUnitCount` integer — The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59 - `maxImpressions` integer — The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set. - `timeUnit` 'TIME_UNIT_UNSPECIFIED' | 'TIME_UNIT_LIFETIME' | 'TIME_UNIT_MONTHS' | 'TIME_UNIT_WEEKS' | 'TIME_UNIT_DAYS' | 'TIME_UNIT_HOURS' | 'TIME_UNIT_MINUTES' — The time unit in which the frequency cap will be applied. Required when unlimited is `false`. - `integrationDetails` IntegrationDetails — Integration details of an entry. - `integrationCode` string — An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters. - `details` string — Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. - `advertiserId` string, int64 — Output only. The unique ID of the advertiser the insertion order belongs to. - `budget` InsertionOrderBudget — Settings that control how insertion order budget is allocated. - `budgetUnit` 'BUDGET_UNIT_UNSPECIFIED' | 'BUDGET_UNIT_CURRENCY' | 'BUDGET_UNIT_IMPRESSIONS' — Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. - `budgetSegments` InsertionOrderBudgetSegment[] — Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running. - `dateRange` DateRange — A date range. - `startDate` Date — Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - `year` integer — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. - `day` integer — Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. - `month` integer — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. - `endDate` Date — Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp - `year` integer — Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. - `day` integer — Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. - `month` integer — Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. - `budgetAmountMicros` string, int64 — Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency. - `description` string — Optional. The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. - `campaignBudgetId` string, int64 — Optional. The budget_id of the campaign budget that this insertion order budget segment is a part of. - `automationType` 'INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED' | 'INSERTION_ORDER_AUTOMATION_TYPE_BUDGET' | 'INSERTION_ORDER_AUTOMATION_TYPE_NONE' | 'INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET' — Optional. The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. - `insertionOrderId` string, int64 — Output only. The unique ID of the insertion order. Assigned by the system. ## Response `200` Successful response --- [API](https://skmtc.dev/google/apis/displayvideo.md) · [All operations](https://skmtc.dev/google/apis/displayvideo/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/google/displayvideo/revisions/68b64e49eced/schema)