Method: advertisers.insertionOrders.patch

  • This request updates an existing insertion order using a PATCH request to a specified URL.

  • To identify the insertion order, you'll need to include insertionOrder.advertiserId and insertionOrder.insertionOrderId as path parameters.

  • You can control which fields get updated by using the updateMask query parameter with a comma-separated list of field names.

  • The request and response bodies both utilize the InsertionOrder object to handle data.

  • 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/v3/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.