REST Resource: orders

Ресурс: Заказать

Заказ — это набор Lines , определяющих, когда и где показывать рекламу.

JSON-представление 
{
  "name": string,
  "externalId": string,
  "displayName": string,
  "description": string,
  "orderState": enum (OrderState),
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
Поля
name

string

Только вывод. Имя ресурса заказа в формате:orders/{id}`.

externalId

string

Необязательный. Идентификатор, используемый для сопоставления этого объекта с внешними источниками.

displayName

string

Только вывод. Отображаемое имя заказа.

Должен быть в кодировке UTF-8 с максимальным размером 240 байт.

description

string

Только вывод. Дополнительное поле произвольной формы для описания заказа.

orderState

enum ( OrderState )

Только вывод. Представляет вычисленное состояние заказа на основе состояния его строк.

createTime

string ( Timestamp format)

Только вывод. Временная метка создания заказа.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

updateTime

string ( Timestamp format)

Только вывод. Дата последнего обновления заказа.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

advertiserInfo

object ( AdvertiserInfo )

Только вывод. Информация о рекламодателе.

Состояние заказа

Состояние заказа.

Перечисления
ORDER_STATE_UNSPECIFIED Значение по умолчанию, если состояние заказа не указано или неизвестно в этой версии.
ORDER_STATE_PENDING_RESERVATION

Заказ содержит:

  • одна или несколько строк в состоянии ожидания резервирования.
  • ноль или более строк в зарезервированном состоянии.
  • нулевые линии во всех остальных состояниях.
ORDER_STATE_RESERVED

Заказ содержит:

  • ноль строк в состоянии ожидания резервирования.
  • одна или несколько строк в зарезервированном состоянии.
  • ноль или более строк в состоянии «Отклонено продавцом».
  • нулевые линии во всех остальных состояниях.
ORDER_STATE_PENDING_BOOKING

Заказ содержит:

  • ноль строк в состоянии ожидания резервирования.
  • ноль строк в зарезервированном состоянии.
  • одна или несколько строк в состоянии ожидания бронирования.
  • ноль или более строк в состоянии «Отклонено продавцом».
  • ноль или более строк отменены покупателем.
  • нулевые линии во всех остальных состояниях.
ORDER_STATE_BOOKED

Заказ содержит:

  • ноль строк в состоянии ожидания резервирования.
  • ноль строк в зарезервированном состоянии.
  • ноль строк в состоянии ожидания бронирования.
  • одна или несколько линий в зарезервированном состоянии.
  • ноль или более строк в состоянии «Отклонено продавцом».
  • ноль или более строк отменены покупателем.
  • нулевые линии во всех остальных состояниях.
ORDER_STATE_REJECTED_BY_SELLER

Заказ содержит:

  • ноль строк в состоянии ожидания резервирования.
  • ноль строк в зарезервированном состоянии.
  • ноль строк в состоянии ожидания бронирования.
  • ноль строк в забронированном состоянии.
  • одна или несколько строк в состоянии «Отклонено продавцом».
  • нулевые строки отменены покупателем.
  • нулевые линии во всех остальных состояниях.
ORDER_STATE_CANCELLED_BY_BUYER

Заказ содержит:

  • ноль строк в состоянии ожидания резервирования.
  • ноль строк в зарезервированном состоянии.
  • ноль строк в состоянии ожидания бронирования.
  • ноль строк в забронированном состоянии.
  • нулевые строки в состоянии отклонено продавцом.
  • одна или несколько строк отменены покупателем.
  • нулевые линии во всех остальных состояниях.
ORDER_STATE_PENDING_RESERVATION_EXPIRED

Заказ содержит:

  • срок действия одной или нескольких строк в ожидающем резервировании истек.
  • нулевые линии во всех остальных состояниях.
ORDER_STATE_RESERVED_EXPIRED

Заказ содержит:

  • Срок действия одной или нескольких строк в зарезервированном списке истек.
  • нулевые линии во всех остальных состояниях.

Методы

get

 Получает индивидуальный заказ.

list

 Перечисляет заказы.

patch

 Обновляет существующий заказ.