Method: exchanges.orders.patch

Actualiza un pedido.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
order.name

string

Es el nombre del recurso relativo del pedido. El servidor lo genera. Ejemplo: “exchanges/1234/orders/5678”. Solo salida.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON
{
  "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,
    "buyerInfo": {
      "partner": {
        object (PartnerInfo)
      },
      "advertisers": [
        {
          object (AdvertiserInfo)
        }
      ]
    }
  },
  "updateMask": string
}
Campos
order.displayName

string

Es el nombre del pedido que se muestra al comprador. Máx. 250 caracteres. Opcional.

order.partnerId[]

string (int64 format)

Es el ID de socio en Google Display & Video 360, antes conocido como DoubleClick Bid Manager(DBM). Solo permite un ID de socio. Es obligatorio.

order.publisherEmail

string

Correo electrónico del publicador. Debe ser un formato de correo electrónico válido. Máx. 250 caracteres. Opcional.

order.publisherName

string

Nombre del editor. Máx. 250 caracteres. Es obligatorio.

order.budget

object (Budget)

Solo salida. Es el presupuesto establecido por el comprador. Solo se aplica a situaciones de acuerdos instantáneos.

order.status

enum (OrderStatus)

Es el estado del pedido. El estado puede cambiar después de que los usuarios de DV3 acepten, cancelen o archiven un pedido. También se admite la actualización a "CANCELLED" después de la creación en la API para indicar que se canceló este pedido en el Exchange.

order.wseatConfig

object (WSeatConfig)

Opcional. WSeat Configuration Especifica la configuración de WSeat en el lado del intercambio. Se espera que los intercambios que utilizan acuerdos de múltiples posiciones mantengan este campo actualizado y completo.

order.updateTime

string (Timestamp format)

Solo salida. Es la marca de tiempo en la que se actualizó el pedido o sus productos subyacentes.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizada a Z y usa 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

order.buyerInfo

object (BuyerInfo)

Solo salida. Es la información del comprador, incluidos los detalles del socio y el anunciante. Solo se aplica a situaciones de acuerdos instantáneos.

updateMask

string (FieldMask format)

Es la máscara para controlar qué campos se actualizarán. Es obligatorio.

Esta es una lista separada por comas de los nombres de campos totalmente calificados. Ejemplo: "user.displayName,photo".

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Order.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/doubleclickbidmanager

Para obtener más información, consulta OAuth 2.0 Overview.