Method: exchanges.orders.patch

Updates an order.

HTTP request

PATCH https://dv360seller.googleapis.com/v1beta1/{order.name=exchanges/*/orders/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
order.name

string

Relative resource name for order. Generated by server. Example: "exchanges/1234/orders/5678". Ourput Only.

Request body

The request body contains data with the following structure:

JSON representation 
{
  "order": {
    "name": string,
    "displayName": string,
    "partnerId": [
      string
    ],
    "publisherEmail": string,
    "publisherName": string,
    "budget": {
      "budgetType": enum (BudgetType),

      // Union field budget can be only one of the following:
      "impressions": string,
      "money": {
        object (Money)
      }
      // End of list of possible types for union field budget.
    },
    "status": enum (OrderStatus),
    "wseatConfig": {
      "exchangeWseatStatus": enum (WSeatStatus),
      "exchangeWseatIds": [
        string
      ],
      "updateTime": string
    },
    "updateTime": string
  },
  "updateMask": string
}
Fields
order.displayName

string

Name of order displayed to the buyer. Max 250 characters. Optional.
order.partnerId[]

string (int64 format)

Partner IDs in Google Display & Video 360, previously known as Doubleclick Bid Manager(DBM). Required.
order.publisherEmail

string

Email for publisher. Must be valid email format. Max 250 characters. Optional.
order.publisherName

string

Publisher name. Max 250 characters. Required.
order.budget

object (Budget)

Budget. Only applicable for Instant Deal Scenarios. Output only.
order.status

enum (OrderStatus)

Order status. The status can change after DV3 users accept, cancel or archive an order. Also support update to 'CANCELLED' after creation in API to signal this order has been cancelled on Exchange.
order.wseatConfig

object (WSeatConfig)

Optional. WSeat Configuration Specifies the WSeat configuration on the exchange side. Exchanges that utilizes multi-seat deals are expected to keep this field populated and up to date.
order.updateTime

string (Timestamp format)

Output only. The timestamp when the order or its underlying products were updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateMask

string (FieldMask format)

The mask to control which fields to update. Required.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

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.