REST Resource: orders

• Recurso: Order
  • Representación JSON
• OrderState
• Métodos

Recurso: Order

Un pedido es una colección de Lines que especifica cuándo y dónde mostrar anuncios.

Representación JSON
{ "name": string, "externalId": string, "displayName": string, "description": string, "orderState": enum (OrderState), "createTime": string, "updateTime": string, "advertiserInfo": { object (AdvertiserInfo) } }

Campos
name	string Solo salida. El nombre de recurso del pedido en el formato: orders/{id}`.
externalId	string Opcional. Es el ID que se usa para asignar esta entidad a fuentes externas.
displayName	string Solo salida. Es el nombre visible del pedido. Debe estar codificado en UTF-8, con un tamaño máximo de 240 bytes.
description	string Solo salida. Es el campo de formato libre adicional para describir el pedido.
orderState	enum (OrderState) Solo salida. Representa el estado calculado del pedido en función del estado de las líneas.
createTime	string (Timestamp format) Solo salida. Es la marca de tiempo de creación del pedido. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
updateTime	string (Timestamp format) Solo salida. Marca de tiempo de la última actualización del pedido Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
advertiserInfo	object (AdvertiserInfo) Solo salida. Información del anunciante

OrderState

Es el estado del pedido.

Enumeraciones
ORDER_STATE_UNSPECIFIED	El valor predeterminado cuando el estado del pedido no se especificó o se desconoce en esta versión.
ORDER_STATE_PENDING_RESERVATION	El pedido contiene lo siguiente: una o más líneas en estado de reserva pendiente. cero o más líneas en estado reservado. cero líneas en todos los demás estados.
ORDER_STATE_RESERVED	El pedido contiene lo siguiente: cero líneas en el estado de reserva pendiente. una o más líneas en estado reservado. cero o más líneas rechazadas por el estado del vendedor cero líneas en todos los demás estados.
ORDER_STATE_PENDING_BOOKING	El pedido contiene lo siguiente: cero líneas en el estado de reserva pendiente. cero líneas en estado reservado. una o más líneas en estado de reserva pendiente. cero o más líneas rechazadas por el estado del vendedor El comprador canceló ninguna o más líneas. cero líneas en todos los demás estados.
ORDER_STATE_BOOKED	El pedido contiene lo siguiente: cero líneas en el estado de reserva pendiente. cero líneas en estado reservado. cero líneas en estado de reserva pendiente una o más líneas en estado reservado. cero o más líneas rechazadas por el estado del vendedor El comprador canceló ninguna o más líneas. cero líneas en todos los demás estados.
ORDER_STATE_REJECTED_BY_SELLER	El pedido contiene lo siguiente: cero líneas en el estado de reserva pendiente. cero líneas en estado reservado. cero líneas en estado de reserva pendiente cero líneas en el estado reservado. una o más líneas rechazadas por estado de vendedor cero líneas canceladas por el comprador cero líneas en todos los demás estados.
ORDER_STATE_CANCELLED_BY_BUYER	El pedido contiene lo siguiente: cero líneas en el estado de reserva pendiente. cero líneas en estado reservado. cero líneas en estado de reserva pendiente cero líneas en el estado reservado. cero líneas en rechazadas por el estado del vendedor. el comprador canceló una o más líneas. cero líneas en todos los demás estados.
ORDER_STATE_PENDING_RESERVATION_EXPIRED	El pedido contiene lo siguiente: una o más líneas de la reserva pendiente vencieron. cero líneas en todos los demás estados.
ORDER_STATE_RESERVED_EXPIRED	El pedido contiene lo siguiente: una o más líneas de la reserva vencieron. cero líneas en todos los demás estados.

Métodos
get	Recupera un pedido individual.
list	Muestra una lista de pedidos.
patch	Actualiza un pedido existente.