Method: advertisers.insertionOrders.patch

  • Display & Video 360 API v1 is sunset and this documentation details updating existing insertion orders using the v1 API.

  • This guide provides instructions for making an HTTP PATCH request to modify insertion orders, including specifying necessary path and query parameters.

  • Developers must provide an updateMask query parameter to indicate the specific insertion order fields to be updated.

  • The request body should contain the updated InsertionOrder object, and a successful response will return the modified InsertionOrder.

  • Authorization requires the https://www.googleapis.com/auth/display-video OAuth scope.

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

HTTP request

PATCH https://displayvideo.googleapis.com/v1/advertisers/{insertionOrder.advertiserId}/insertionOrders/{insertionOrder.insertionOrderId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
insertionOrder.advertiserId

string (int64 format)

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

string (int64 format)

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

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The mask to control which fields to update.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of InsertionOrder.

Response body

If successful, the response body contains an instance of InsertionOrder.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/display-video

For more information, see the OAuth 2.0 Overview.