REST Resource: orders

Recurso: Order

Um pedido é um conjunto de Lines que especifica quando e onde exibir os anúncios.

Representação JSON 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
Campos
name

string

Apenas saída. O nome de recurso do pedido no formato: orders/{id}`.
externalId

string

Opcional. Um ID usado para mapear esta entidade para origens externas.
displayName

string

Apenas saída. O nome de exibição do pedido.

Precisa ser codificado em UTF-8 com tamanho máximo de 240 bytes.
description

string

Apenas saída. Campo de formato livre adicional para descrever o pedido.
orderState

enum (OrderState)

Apenas saída. Representa o estado calculado do pedido com base no estado das linhas.
createTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de criação do pedido.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora da última atualização do pedido.

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
advertiserInfo

object (AdvertiserInfo)

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

OrderState

O estado do pedido.

Enums
ORDER_STATE_UNSPECIFIED O valor padrão quando o estado do pedido não foi especificado ou é desconhecido nesta versão.
ORDER_STATE_PENDING_RESERVATION

O pedido contém:

  • uma ou mais linhas no estado de reserva pendente.
  • zero ou mais linhas no estado reservado.
  • nenhuma linha em todos os outros estados.
ORDER_STATE_RESERVED

O pedido contém:

  • zero linhas no estado de reserva pendente.
  • uma ou mais linhas no estado reservado.
  • zero ou mais linhas foram rejeitadas pelo estado do vendedor.
  • nenhuma linha em todos os outros estados.
ORDER_STATE_PENDING_BOOKING

O pedido contém:

  • zero linhas no estado de reserva pendente.
  • nenhuma linha no estado reservado.
  • uma ou mais linhas no estado de reserva pendente.
  • zero ou mais linhas em rejeitado pelo estado do vendedor.
  • nenhuma ou mais linhas foram canceladas pelo comprador.
  • nenhuma linha em todos os outros estados.
ORDER_STATE_BOOKED

O pedido contém:

  • zero linhas no estado de reserva pendente.
  • nenhuma linha no estado reservado.
  • zero linha no estado de reserva pendente.
  • uma ou mais linhas no estado reservado.
  • zero ou mais linhas em rejeitado pelo estado do vendedor.
  • nenhuma ou mais linhas foram canceladas pelo comprador.
  • nenhuma linha em todos os outros estados.
ORDER_STATE_REJECTED_BY_SELLER

O pedido contém:

  • zero linhas no estado de reserva pendente.
  • nenhuma linha no estado reservado.
  • zero linha no estado de reserva pendente.
  • nenhuma linha no estado reservado.
  • uma ou mais linhas são rejeitadas pelo estado do vendedor.
  • nenhuma linha cancelada pelo comprador.
  • nenhuma linha em todos os outros estados.
ORDER_STATE_CANCELLED_BY_BUYER

O pedido contém:

  • zero linhas no estado de reserva pendente.
  • nenhuma linha no estado reservado.
  • zero linha no estado de reserva pendente.
  • nenhuma linha no estado reservado.
  • zero linhas em rejeitado pelo estado do vendedor.
  • uma ou mais linhas canceladas pelo comprador.
  • nenhuma linha em todos os outros estados.
ORDER_STATE_PENDING_RESERVATION_EXPIRED

O pedido contém:

  • uma ou mais linhas na reserva pendente expiraram.
  • nenhuma linha em todos os outros estados.
ORDER_STATE_RESERVED_EXPIRED

O pedido contém:

  • uma ou mais linhas em reservado expiraram.
  • nenhuma linha em todos os outros estados.

Métodos

get

 Recupera um pedido individual.

list

 Lista os pedidos.

patch

 Atualiza um pedido existente.