REST Resource: exchanges.orders

Recurso: Order

Uma oferta não negociável para um comprador aceitar.

Representação JSON 
{
  "name": string,
  "displayName": string,
  "partnerId": [
    string
  ],
  "publisherEmail": string,
  "publisherName": string,
  "budget": {
    object (Budget)
  },
  "status": enum (OrderStatus),
  "wseatConfig": {
    object (WSeatConfig)
  },
  "updateTime": string,
  "buyerInfo": {
    object (BuyerInfo)
  }
}
Campos
name

string

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

string

Nome do pedido exibido ao comprador. Máximo de 250 caracteres. Opcional.
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.
publisherEmail

string

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

string

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

object (Budget)

Apenas saída. O orçamento definido pelo comprador. Aplicável apenas a cenários de oferta instantânea.
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.
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.
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".
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.

Orçamento

Orçamento especificado.

Representação JSON 
{
  "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.
}
Campos
budgetType

enum (BudgetType)

O tipo de orçamento especificado.
Campo de união budget. Só é possível incluir um tipo de orçamento. budget pode ser apenas de um dos tipos a seguir:
impressions

string (int64 format)

Orçamento de impressão.
money

object (Money)

Orçamento em moeda.

BudgetType

Tipos de orçamento

Enums
BUDGET_TYPE_UNSPECIFIED Orçamento não especificado. Não é válido para entrada.
BUDGET_TYPE_CURRENCY Orçamento em moeda.
BUDGET_TYPE_IMPRESSION Orçamento de impressão.

OrderStatus

Status do pedido.

Enums
ORDER_STATUS_UNSPECIFIED Status do pedido não especificado. Inesperado, indica que o status da negociação é desconhecido. Valor de entrada inválido.
PENDING_ACCEPTANCE Status do pedido: aguardando aceitação.
ACCEPTED Status do pedido: aceito.
ARCHIVED O status do pedido foi arquivado.
CANCELLED O status do pedido foi cancelado.
NEGOTIATING Status do pedido em negociação. Aplicável somente a cenários de transação instantânea.

WSeatConfig

Configuração do WSeat.

Representação JSON 
{
  "exchangeWseatStatus": enum (WSeatStatus),
  "exchangeWseatIds": [
    string
  ],
  "updateTime": string
}
Campos
exchangeWseatStatus

enum (WSeatStatus)

Opcional. O status atual no lado da troca para a configuração do WSeat.
exchangeWseatIds[]

string (int64 format)

Opcional. IDs de WSeat no lado da troca.
updateTime

string (Timestamp format)

Apenas saída. Esse campo é atualizado automaticamente pelo DV3 quando a troca atualiza o WSeatConfiguration.

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".

WSeatStatus

Opções de enumeração do status do WSeat.

Enums
W_SEAT_STATUS_UNSPECIFIED WSeatStatus não especificado.
W_SEAT_STATUS_ENFORCED WSeatStatus aplicado. Indica que o Exchange aplica o WSeatId enviando-o para a DV3 ou verificando os wseatids nas respostas de lances.
W_SEAT_STATUS_NOT_ENFORCED WSeatStatus não aplicado. Indica que a troca não envia wseatid em solicitações de lance e não valida wseatid em solicitações de lance.

BuyerInfo

Informações do comprador para cenários de transação instantânea.

Representação JSON 
{
  "partner": {
    object (PartnerInfo)
  },
  "advertisers": [
    {
      object (AdvertiserInfo)
    }
  ]
}
Campos
partner

object (PartnerInfo)

Apenas saída. Informações do parceiro.
advertisers[]

object (AdvertiserInfo)

Apenas saída. Informações do anunciante.

PartnerInfo

Informações do parceiro para cenários de transação instantânea.

Representação JSON 
{
  "title": string
}
Campos
title

string

Apenas saída. Título de exibição do parceiro no Display & Video 360.

AdvertiserInfo

Informações do anunciante para cenários de transação instantânea.

Representação JSON 
{
  "advertiserId": string,
  "domainUri": string
}
Campos
advertiserId

string (int64 format)

Apenas saída. ID do anunciante no Display & Video 360.
domainUri

string

Apenas saída. O URI do domínio do site do anunciante.

Métodos

accept

 Aceita o pedido.

create

 Cria um pedido.

get

 Recebe o pedido.

list

 Lista de pedidos.

patch

 Atualiza um pedido.