Method: guaranteedOrders.patch

  • This document outlines how to update an existing guaranteed order using the Display & Video 360 API.

  • The API request requires specifying the guaranteed order ID and the fields to be updated using a field mask.

  • Users need to identify the request context by providing either partner or advertiser ID.

  • Successful requests will return the updated guaranteed order details in the response.

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

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

HTTP request

PATCH https://displayvideo.googleapis.com/v1/guaranteedOrders/{guaranteedOrder.guaranteedOrderId}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
guaranteedOrder.guaranteedOrderId

string

Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format {exchange}-{legacyGuaranteedOrderId}.

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".

Union parameter accessor. Required.

Identifies which DV360 entity the request is being made within. accessor can be only one of the following:
partnerId

string (int64 format)

The ID of the partner that the request is being made within.
advertiserId

string (int64 format)

The ID of the advertiser that the request is being made within.

Request body

The request body contains an instance of GuaranteedOrder.

Response body

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

Authorization Scopes

Requires the following OAuth scope:

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

For more information, see the OAuth 2.0 Overview.