Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13177414729.5 KB
advertisers

Updates an existing insertion order. Returns the updated insertion order if successful.

patch/v4/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}

Path parameters

advertiserIdstring required

Output only. The unique ID of the advertiser the insertion order belongs to.

insertionOrderIdstring required

Output only. The unique ID of the insertion order. Assigned by the system.

Query parameters

updateMaskstring

Required. The mask to control which fields to update.

Request body

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.

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.

namestring

Output only. The resource name of the insertion order.

displayNamestring

Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.

updateTimestring google-datetime

Output only. The timestamp when the insertion order was last updated. Assigned by the system.

campaignIdstring int64

Required. Immutable. The unique ID of the campaign that the insertion order belongs to.

advertiserIdstring int64

Output only. The unique ID of the advertiser the insertion order belongs to.

insertionOrderIdstring int64

Output only. The unique ID of the insertion order. Assigned by the system.

Response

Successful response