REST Resource: orders.lines

Recurso: linha

Uma única linha de pedido que representa um produto configurado.

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

Apenas saída. O nome de recurso da linha no formato: orders/{order_id}/lines/{id}.
product

string

Apenas saída. O nome do Product que essa linha está configurando. Formato = produtos/123
externalId

string

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

string

Apenas saída. O nome de exibição da linha.
description

string

Apenas saída. Campo de formato livre adicional para descrever a linha.
lineState

enum (LineState)

Apenas saída. O estado da linha. Consulte LineState para ver o ciclo de vida de uma linha.

O vendedor pode usar os seguintes métodos personalizados: Reserve, Book e Reject para definir como um dos seguintes:

  • LINE_STATE_RESERVED
  • LINE_STATE_BOOKED
  • LINE_STATE_REJECTED_BY_SELLER.

Todos os outros estados da linha são definidos pelo comprador.
rejection

object (Rejection)

Opcional. Detalhes da rejeição da linha.
startTime
(deprecated)

string (Timestamp format)

Apenas saída. Quando a linha começaria a ser veiculada (inclusive).

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".
endTime
(deprecated)

string (Timestamp format)

Apenas saída. Quando a linha deixaria de ser veiculada (exclusivo).

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

object (Date)

Apenas saída. A data em que a linha começaria a ser veiculada (inclusive). Mesmo fuso horário que o bloco de anúncios.
endDate

object (Date)

Apenas saída. A data em que a linha deixaria de ser veiculada (inclusive). Mesmo fuso horário que o bloco de anúncios.
budget

object (Money)

Apenas saída. O orçamento da linha.
lineTerms

object (LineTerms)

Apenas saída. Os termos garantidos do vendedor para esta linha.
pendingReservationExpirationTime

string (Timestamp format)

Apenas saída. Carimbo de data/hora de expiração da reserva pendente. O vendedor precisa fazer a reserva ou recusar antes que uma reserva pendente expire. Caso contrário, ela será tratada como recusada.

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

string (Timestamp format)

Apenas saída. Carimbo de data/hora de expiração da reserva. O comprador precisa fazer a reserva antes que ela expire. Caso contrário, ela será tratada como cancelada.

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

object (Targeting)

Apenas saída. A segmentação da linha.
createTime

string (Timestamp format)

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

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 da linha.

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

LineState

Estado de uma linha.

Enums
LINE_STATE_UNSPECIFIED O valor padrão quando o estado da linha não foi especificado ou é desconhecido nesta versão.
LINE_STATE_PENDING_RESERVATION A linha foi criada pelo comprador e solicita que os produtos sejam reservados, além de atualizados com informações de preço e disponibilidade.
LINE_STATE_RESERVED A linha foi reservada pelo vendedor. Esse estado só é possível quando o estado anterior é uma reserva pendente.
LINE_STATE_PENDING_BOOKING O comprador aceitou a reserva e está solicitando a linha para ser reservada.
LINE_STATE_BOOKED O vendedor reservou a linha. Esse estado só é possível quando o estado anterior está com reserva pendente. Não são esperadas rejeições nesta fase.
LINE_STATE_REJECTED_BY_SELLER A linha foi rejeitada pelo vendedor. Esse estado só é possível quando o estado anterior é uma reserva pendente.
LINE_STATE_CANCELLED_BY_BUYER A linha foi cancelada pelo comprador.
LINE_STATE_PENDING_RESERVATION_EXPIRED A linha expirou enquanto a reserva estava pendente.
LINE_STATE_RESERVED_EXPIRED A linha expirou enquanto reservada, aguardando a resposta do comprador.

Métodos

book

 Contrata uma linha existente.

get

 Recupera uma linha individual de um pedido.

list

 Lista as linhas de um pedido.

patch

 Atualiza uma linha existente.

reject

 Rejeita uma linha existente.

reserve

 Reserva uma linha existente.