REST Resource: orders.lines

Recurso: Line

Una sola línea de pedido que representa un producto configurado.

Representación JSON
{
  "name": string,
  "product": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "lineState": enum (LineState),
  "rejection": {
    object (Rejection)
  },
  "startTime": string,
  "endTime": string,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "budget": {
    object (Money)
  },
  "lineTerms": {
    object (LineTerms)
  },
  "pendingReservationExpirationTime": string,
  "reservationExpirationTime": string,
  "targeting": {
    object (Targeting)
  },
  "createTime": string,
  "updateTime": string
}
Campos
name

string

Solo salida. El nombre del recurso de la línea en formato: orders/{order_id}/lines/{id}.

product

string

Solo salida. El nombre de Product que está configurando esta línea. Formato = productos/123

externalId

string

Opcional. Es el ID que se usa para asignar esta entidad a fuentes externas.

displayName

string

Solo salida. El nombre visible de la línea.

description

string

Solo salida. Campo de forma libre adicional para describir la línea.

lineState

enum (LineState)

Solo salida. Es el estado de la línea. Consulta LineState para ver el ciclo de vida de una línea.

El vendedor puede usar los siguientes métodos personalizados: Reserve, Book y Reject para establecerse en una de las siguientes opciones:

  • LINE_STATE_RESERVED
  • LINE_STATE_BOOKED
  • LINE_STATE_REJECTED_BY_SELLER.

El comprador establece todos los demás estados de línea.

rejection

object (Rejection)

Opcional. Detalles del rechazo de la línea.

startTime
(deprecated)

string (Timestamp format)

Solo salida. Indica cuándo se empezaría a servir la línea (inclusive).

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

endTime
(deprecated)

string (Timestamp format)

Solo salida. Cuándo se dejará de publicar la línea (exclusivo).

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

startDate

object (Date)

Solo salida. Es la fecha en la que se empezaría a publicar la línea (inclusive). Debe tener la misma zona horaria que la unidad de anuncios.

endDate

object (Date)

Solo salida. Es la fecha en la que se dejará de prestar servicio en la línea (inclusive). Debe tener la misma zona horaria que la unidad de anuncios.

budget

object (Money)

Solo salida. El presupuesto de la línea.

lineTerms

object (LineTerms)

Solo salida. Son los términos garantizados por el vendedor para esta línea.

pendingReservationExpirationTime

string (Timestamp format)

Solo salida. Marca de tiempo de vencimiento de la reserva pendiente. El vendedor debe reservar o rechazar la reserva antes de que venza. De lo contrario, se considerará como rechazada.

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

reservationExpirationTime

string (Timestamp format)

Solo salida. Marca de tiempo de vencimiento de la reserva. El comprador debe hacer la reserva antes de que venza. De lo contrario, se considerará cancelada.

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

targeting

object (Targeting)

Solo salida. La segmentación de la línea.

createTime

string (Timestamp format)

Solo salida. Marca de tiempo de creación de la línea.

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 de la línea

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

LineState

Estado de una línea.

Enumeraciones
LINE_STATE_UNSPECIFIED El valor predeterminado cuando el estado de la línea no se especificó o se desconoce en esta versión.
LINE_STATE_PENDING_RESERVATION El comprador creó la línea y solicita que los productos se reserven y actualicen con información sobre los precios y la disponibilidad.
LINE_STATE_RESERVED El vendedor reservó la línea. Este estado solo es posible si el estado anterior es una reserva pendiente.
LINE_STATE_PENDING_BOOKING El comprador aceptó la reserva y solicita que se reserve la línea.
LINE_STATE_BOOKED El vendedor reservó la línea. Este estado solo es posible si el estado anterior es la reserva pendiente. No se esperan rechazos en esta etapa.
LINE_STATE_REJECTED_BY_SELLER El vendedor rechazó la línea. Este estado solo es posible si el estado anterior es una reserva pendiente.
LINE_STATE_CANCELLED_BY_BUYER El comprador canceló la línea.
LINE_STATE_PENDING_RESERVATION_EXPIRED La línea venció mientras estaba pendiente la reserva.
LINE_STATE_RESERVED_EXPIRED La línea venció mientras estaba reservada, a la espera de la respuesta del comprador.

Métodos

book

Reserva una línea existente.

get

Recupera una línea individual para un pedido.

list

Muestra las líneas de un pedido.

patch

Actualiza una línea existente.

reject

Rechaza una línea existente.

reserve

Reserva una línea existente.