REST Resource: orders

Zasób: zamówienie

Zamówienie to zbiór elementów Lines, który określa czas i miejsce wyświetlania reklam.

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

string

Tylko dane wyjściowe. Nazwa zasobu zamówienia w formacie: zamówienia/{id}`.
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 zamówienia.

Musi być zakodowany w standardzie UTF-8 i maksymalnym rozmiarze 240 bajtów.
description

string

Tylko dane wyjściowe. Dodatkowe dowolne pole do opisania zamówienia.
orderState

enum (OrderState)

Tylko dane wyjściowe. Reprezentuje obliczony stan zamówienia na podstawie stanu jego wierszy.
createTime

string (Timestamp format)

Tylko dane wyjściowe. Sygnatura czasowa utworzenia zamówienia.

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 zamówienia.

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

object (AdvertiserInfo)

Tylko dane wyjściowe. Informacje o reklamodawcy.

OrderState

Stan zamówienia.

Wartości w polu enum
ORDER_STATE_UNSPECIFIED Wartość domyślna, gdy stan zamówienia nie został określony lub jest nieznany w tej wersji.
ORDER_STATE_PENDING_RESERVATION

Zamówienie zawiera:

  • co najmniej jeden wiersz w stanie oczekiwania na rezerwację.
  • zero lub więcej wierszy w stanie zarezerwowania.
  • zero linii w pozostałych stanach.
ORDER_STATE_RESERVED

Zamówienie zawiera:

  • 0 wierszy w stanie oczekiwania na rezerwację.
  • co najmniej jeden wiersz w stanie zarezerwowanym.
  • 0 lub więcej wierszy odrzuconych przez sprzedawcę.
  • zero linii w pozostałych stanach.
ORDER_STATE_PENDING_BOOKING

Zamówienie zawiera:

  • 0 wierszy w stanie oczekiwania na rezerwację.
  • 0 wierszy w stanie zarezerwowanym.
  • co najmniej jeden wiersz w stanie oczekiwania na rezerwację.
  • 0 lub więcej wierszy odrzuconych przez sprzedawcę.
  • Anulowane przez kupującego nie zawiera żadnych wierszy lub więcej wierszy.
  • zero linii w pozostałych stanach.
ORDER_STATE_BOOKED

Zamówienie zawiera:

  • 0 wierszy w stanie oczekiwania na rezerwację.
  • 0 wierszy w stanie zarezerwowanym.
  • 0 wierszy w stanie oczekiwania na rezerwację.
  • co najmniej jeden wiersz w stanie rezerwacji.
  • 0 lub więcej wierszy odrzuconych przez sprzedawcę.
  • Anulowane przez kupującego nie zawiera żadnych wierszy lub więcej wierszy.
  • zero linii w pozostałych stanach.
ORDER_STATE_REJECTED_BY_SELLER

Zamówienie zawiera:

  • 0 wierszy w stanie oczekiwania na rezerwację.
  • 0 wierszy w stanie zarezerwowanym.
  • 0 wierszy w stanie oczekiwania na rezerwację.
  • zero wierszy w stanie rezerwacji.
  • co najmniej jeden wiersz odrzucony przez stan sprzedawcy.
  • Anulowane przez kupującego nie zawiera żadnych wierszy.
  • zero linii w pozostałych stanach.
ORDER_STATE_CANCELLED_BY_BUYER

Zamówienie zawiera:

  • 0 wierszy w stanie oczekiwania na rezerwację.
  • 0 wierszy w stanie zarezerwowanym.
  • 0 wierszy w stanie oczekiwania na rezerwację.
  • zero wierszy w stanie rezerwacji.
  • Brak wierszy odrzuconych przez stan sprzedawcy.
  • co najmniej jeden wiersz w pozycji anulowany przez kupującego.
  • zero linii w pozostałych stanach.
ORDER_STATE_PENDING_RESERVATION_EXPIRED

Zamówienie zawiera:

  • co najmniej 1 wiersz oczekującej rezerwacji wygasł.
  • zero linii w pozostałych stanach.
ORDER_STATE_RESERVED_EXPIRED

Zamówienie zawiera:

  • co najmniej jeden wiersz w zarezerwowanym tekście stracił ważność.
  • zero linii w pozostałych stanach.

Metody

get

 Pobiera pojedyncze zamówienie.

list

 Wyświetla listę zamówień.

patch

 Aktualizuje istniejące zamówienie.