Method: orders.patch
Stay organized with collections
Save and categorize content based on your preferences.
Updates an existing order.
- Returns the updated order if successful.
- Returns error code
NOT_FOUND if the order does not exist.
- Returns error code
INVALID_ARGUMENT if an immutable field is specified in updateMask.
HTTP request
PATCH https://dv360outofhomeseller.googleapis.com/v1beta1/{order.name=orders/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
order.name |
string
Output only. The resource name of the order in the format: orders/{id}`.
|
Query parameters
| Parameters |
updateMask |
string (FieldMask format)
Required. The mask to control which fields to update. An immutable field cannot be specified here. 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 Order.
Response body
If successful, the response body contains an instance of Order.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/doubleclickbidmanager
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 2024-09-18 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["This method updates an existing order using a `PATCH` request to the specified URL."],["It requires a `updateMask` query parameter specifying the fields to be updated."],["The request body should contain an `Order` object with the updated data."],["A successful response returns the updated `Order` object."],["It may return `NOT_FOUND` or `INVALID_ARGUMENT` error codes if the order is not found or if an immutable field is attempted to be updated, respectively."]]],["This documentation details updating an existing order via a `PATCH` request to a specified URL. The `order.name` path parameter identifies the target order. The `updateMask` query parameter specifies which fields to modify, with immutable fields disallowed. The request body contains the updated `Order` data, and a successful response returns the modified `Order`. A `NOT_FOUND` error is returned for a nonexistent order, while `INVALID_ARGUMENT` signals an invalid `updateMask`. Authorization requires the `doubleclickbidmanager` scope.\n"]]
