Starting
September 8, 2025, every new line item will need to declare whether or not they will serve Eurpoean Union (EU) political ads. Display & Video 360 API and SDF uploads that don't provide declarations will fail. See our
deprecations page for more details on how to update your integration to make this declaration.
Method: guaranteedOrders.patch
Stay organized with collections
Save and categorize content based on your preferences.
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 |
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-27 UTC.
[null,null,["Last updated 2025-03-27 UTC."],[],["The Display & Video 360 API v4 (beta) allows updating existing guaranteed orders via a PATCH request. The request URL includes the guaranteed order ID as a path parameter. Required query parameters include `updateMask`, to specify fields for updating, and an `accessor` (`partnerId` or `advertiserId`). The request and response bodies use the `GuaranteedOrder` format. The API uses gRPC Transcoding, and requires OAuth scope `https://www.googleapis.com/auth/display-video`. The request returns the updated guaranteed order upon success.\n"],null,["# Method: guaranteedOrders.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates an existing guaranteed order. Returns the updated guaranteed order if successful.\n\n### HTTP request\n\n`PATCH https://displayvideo.googleapis.com/v4/guaranteedOrders/{guaranteedOrder.guaranteedOrderId}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `guaranteedOrder.guaranteedOrderId` | `string` Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacyGuaranteedOrderId}`. |\n\n### Query parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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\"`. |\n| Union parameter `accessor`. Required. Identifies which DV360 entity the request is being made within. `accessor` can be only one of the following: ||\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the partner that the request is being made within. |\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The ID of the advertiser that the request is being made within. |\n\n### Request body\n\nThe request body contains an instance of [GuaranteedOrder](/display-video/api/reference/rest/v4/guaranteedOrders#GuaranteedOrder).\n\n### Response body\n\nIf successful, the response body contains an instance of [GuaranteedOrder](/display-video/api/reference/rest/v4/guaranteedOrders#GuaranteedOrder).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
