Method: exchanges.orders.patch

Atualiza um pedido.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
order.name

string

Nome do recurso relativo para o pedido. Gerado pelo servidor. Exemplo: "exchanges/1234/orders/5678". Apenas saída.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação 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

Nome do pedido exibido ao comprador. Máximo de 250 caracteres. Opcional.

order.partnerId[]

string (int64 format)

ID do parceiro no Google Display & Video 360, antes conhecido como DoubleClick Bid Manager(DBM). Permite apenas um ID de parceiro. Obrigatório.

order.publisherEmail

string

E-mail para o editor. O e-mail precisa estar em um formato válido. Máximo de 250 caracteres. Opcional.

order.publisherName

string

Nome do publisher. Máximo de 250 caracteres. Obrigatório.

order.budget

object (Budget)

Apenas saída. O orçamento definido pelo comprador. Aplicável apenas a cenários de oferta instantânea.

order.status

enum (OrderStatus)

Status do pedido. O status pode mudar depois que os usuários do DV360 aceitam, cancelam ou arquivam um pedido. Também há suporte para atualização para "CANCELLED" após a criação na API para sinalizar que o pedido foi cancelado na Exchange.

order.wseatConfig

object (WSeatConfig)

Opcional. WSeat Configuration Especifica a configuração do WSeat no lado da troca. As exchanges que usam contratos de várias licenças precisam manter esse campo preenchido e atualizado.

order.updateTime

string (Timestamp format)

Apenas saída. O carimbo de data/hora em que o pedido ou os produtos dele foram atualizados.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

order.buyerInfo

object (BuyerInfo)

Apenas saída. As informações do comprador, incluindo detalhes do parceiro e do anunciante. Aplicável apenas a cenários de oferta instantânea.

updateMask

string (FieldMask format)

A máscara para controlar quais campos serão atualizados. Obrigatório.

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Order.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte OAuth 2.0 Overview.