AI-generated Key Takeaways
-
This document details how to update an existing guaranteed order using the Display & Video 360 API.
-
The update is performed using a PATCH HTTP request to a specific URL that includes the guaranteed order ID.
-
Key parameters for the request include the
guaranteedOrder.guaranteedOrderId,updateMaskto specify fields to update, and eitherpartnerIdoradvertiserIdas an accessor. -
The request and response bodies both contain an instance of a GuaranteedOrder object.
-
Authorization requires the
https://www.googleapis.com/auth/display-videoOAuth scope.
- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- Try it!
Updates an existing guaranteed order. Returns the updated guaranteed order if successful.
HTTP request
PATCH https://displayvideo.googleapis.com/v4/guaranteedOrders/{guaranteedOrder.guaranteedOrderId}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
guaranteedOrder.guaranteedOrderId
|
Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format |
Query 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 .
