Method: orders.patch

Page Summary

• This document details how to update an existing order using a PATCH request.

• The update process requires specifying which fields to update using an updateMask query parameter.

• Successful updates return the modified order, while errors such as NOT_FOUND or INVALID_ARGUMENT may occur for non-existent orders or attempts to modify immutable fields.

• The process utilizes path and query parameters, a request body containing the order data, and a response body that returns the updated order.

• Authorization requires the https://www.googleapis.com/auth/doubleclickbidmanager OAuth scope.

• HTTP request
• Path parameters
• Query parameters
• Request body
• Response body
• Authorization Scopes
• Examples

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.