REST Resource: exchanges.orders

Stay organized with collections Save and categorize content based on your preferences.

Resource: Order

A non-negotiatable offer for a buyer to accept.

JSON representation 
{
  "name": string,
  "displayName": string,
  "partnerId": [
    string
  ],
  "publisherEmail": string,
  "publisherName": string,
  "budget": {
    object (Budget)
  },
  "status": enum (OrderStatus)
}
Fields
name

string

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

string

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

string (int64 format)

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

string

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

string

Publisher name. Max 250 characters. Required.
budget

object (Budget)

Budget. Only applicable for Instant Deal Scenarios. Output only.
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.

Budget

Budget specified.

JSON representation 
{
  "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.
}
Fields
budgetType

enum (BudgetType)

The specified budget type.
Union field budget. Only one type of budget can be included. budget can be only one of the following:
impressions

string (int64 format)

Impression budget.
money

object (Money)

Currency budget.

BudgetType

Budget types

Enums
BUDGET_TYPE_UNSPECIFIED Unspecified budget. Not valid for input.
BUDGET_TYPE_CURRENCY Currency budget.
BUDGET_TYPE_IMPRESSION Impression budget.

OrderStatus

Status for order.

Enums
ORDER_STATUS_UNSPECIFIED Order status unspecified. Unexpected, it indicates the negotiation status is unknown. Not valid input value.
PENDING_ACCEPTANCE Order status pending acceptance.
ACCEPTED Order status accepted.
ARCHIVED Order status archived.
CANCELLED Order status cancelled.
NEGOTIATING Order status negotiating. Only applicable for Instant Deal Scenarios.

Methods

accept

 Accepts order.

create

 Creates an order.

get

 Gets order.

list

 Lists order.

patch

 Updates an order.