REST Resource: orders.lines

Zasób: wiersz

Pojedyncza linia zamówienia, która reprezentuje skonfigurowany produkt.

Zapis 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
}
Pola
name

string

Tylko dane wyjściowe. Nazwa zasobu wiersza w formacie: orders/{order_id}/lines/{id}.
product

string

Tylko dane wyjściowe. Nazwa Product konfigurowanego wiersza. Format = products/123
externalId

string

Opcjonalnie: Identyfikator używany do mapowania tego elementu na źródła zewnętrzne.
displayName

string

Tylko dane wyjściowe. Wyświetlana nazwa wiersza.
description

string

Tylko dane wyjściowe. Dodatkowe pole do opisania linii.
lineState

enum (LineState)

Tylko dane wyjściowe. Stan linii. Informacje o cyklu życia linii znajdziesz w sekcji LineState.

Sprzedawca może użyć tych metod niestandardowych: Reserve, Book i Reject, aby ustawić jedną z tych wartości:

  • LINE_STATE_RESERVED
  • LINE_STATE_BOOKED
  • LINE_STATE_REJECTED_BY_SELLER.

Pozostałe stany zamówienia są ustawiane przez kupującego.
rejection

object (Rejection)

Opcjonalnie: Szczegóły odrzucenia tej linii.
startTime
(deprecated)

string (Timestamp format)

Tylko dane wyjściowe. Data rozpoczęcia wyświetlania wiersza (włącznie).

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
endTime
(deprecated)

string (Timestamp format)

Tylko dane wyjściowe. Kiedy linia przestanie być wyświetlana (z wyłączeniem).

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
startDate

object (Date)

Tylko dane wyjściowe. Data rozpoczęcia wyświetlania (włącznie z tym dniem). Ta sama strefa czasowa co w jednostce reklamowej.
endDate

object (Date)

Tylko dane wyjściowe. Data zakończenia wyświetlania linii (włącznie). Ta sama strefa czasowa co w jednostce reklamowej.
budget

object (Money)

Tylko dane wyjściowe. Budżet linii.
lineTerms

object (LineTerms)

Tylko dane wyjściowe. Warunki gwarantowane sprzedawcy w przypadku tej linii.
pendingReservationExpirationTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa wygaśnięcia oczekującej rezerwacji. Sprzedawca musi dokonać rezerwacji lub odrzucić rezerwację, zanim wygaśnie, ponieważ w przeciwnym razie rezerwacja zostanie potraktowana jako odrzucona.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
reservationExpirationTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa wygaśnięcia rezerwacji. Kupujący musi dokonać rezerwacji przed wygaśnięciem rezerwacji. W przeciwnym razie zostanie ona potraktowana jako anulowana.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
targeting

object (Targeting)

Tylko dane wyjściowe. Kierowanie na linię.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia wiersza.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
updateTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa ostatniej aktualizacji wiersza.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".

LineState

Stan linii.

Wartości w polu enum
LINE_STATE_UNSPECIFIED Wartość domyślna, gdy stan wiersza nie został określony lub jest nieznany w tej wersji.
LINE_STATE_PENDING_RESERVATION Oferta została utworzona przez kupującego i żąda zarezerwowania produktów oraz zaktualizowania informacji o cenie i dostępności.
LINE_STATE_RESERVED Linia została zarezerwowana przez sprzedawcę. Ten stan jest możliwy tylko wtedy, gdy poprzedni stan to oczekująca rezerwacja.
LINE_STATE_PENDING_BOOKING Kupujący zaakceptował rezerwację i prosi o rezerwację w tym wierszu.
LINE_STATE_BOOKED Sprzedawca zarezerwował kolejkę. Ten stan jest możliwy tylko wtedy, gdy poprzedni stan to oczekiwanie na rezerwację. Na tym etapie nie należy się spodziewać odrzucenia.
LINE_STATE_REJECTED_BY_SELLER Wiersz został odrzucony przez sprzedawcę. Ten stan jest możliwy tylko wtedy, gdy poprzedni stan to oczekująca rezerwacja.
LINE_STATE_CANCELLED_BY_BUYER Oferta została anulowana przez kupującego.
LINE_STATE_PENDING_RESERVATION_EXPIRED Linia wygasła podczas oczekiwania na rezerwację.
LINE_STATE_RESERVED_EXPIRED Linia wygasła po zarezerwowaniu i oczekiwanie na odpowiedź kupującego.

Metody

book

 Rezerwuje istniejący wiersz.

get

 Pobiera pojedynczy wiersz zamówienia.

list

 Zawiera listę wierszy zamówienia.

patch

 Aktualizuje istniejącą linię.

reject

 Odrzuca istniejący wiersz.

reserve

 Rezerwuje istniejącą linię.