REST Resource: availabilityOrders

Ресурс: AvailabilityOrder

Заказ доступности — это коллекция AvailabilityLines . Заказ доступности создается покупателем. Продавец сообщает о наличии в ответе.

Рабочий процесс выглядит следующим образом:

  • Покупатель создает заказ и строки доступности и устанавливает состояние ожидания. Дальнейшие изменения покупателем заказа или строки наличия не допускаются.
  • Продавец действует по всем строкам доступности, либо заполняя условия доступности, либо отмечая их как отклоненные. Завершить или отклонить действия возможно только тогда, когда ордер и строки находятся в состоянии ожидания.
  • Продавец использует complete действие «Завершить», чтобы пометить запрос доступности как завершенный. Дальнейшие изменения в заказе доступности или дочерних строках после завершения не допускаются.
JSON-представление 
{
  "name": string,
  "description": string,
  "state": enum (State),
  "pendingExpirationTime": string,
  "createTime": string,
  "updateTime": string,
  "advertiserInfo": {
    object (AdvertiserInfo)
  }
}
Поля
name

string

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

description

string

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

state

enum ( State )

Только вывод. Состояние этого заказа доступности. См. AvailabilityOrder.State , чтобы узнать о жизненном цикле AvailabilityOrder.

Продавец может использовать собственный метод Complete , чтобы установить значение STATE_COMPLETED .

pendingExpirationTime

string ( Timestamp format)

Только вывод. Временная метка истечения срока действия ожидающего заказа на доступность. Продавцу необходимо выполнить заказ до истечения срока действия ожидающего заказа, иначе он будет считаться выполненным без наличия мест.

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

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 )

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

Состояние

Возможные значения состояния заказа доступности.

Перечисления
STATE_UNSPECIFIED Значение по умолчанию, когда состояние заказа доступности не указано или неизвестно в этой версии.
STATE_PENDING Ожидание доступности, когда покупатель предоставил настройки запроса доступности.
STATE_COMPLETED Состояние доступности завершено, когда продавец предоставил ответ о доступности для всех строк.
STATE_CANCELLED Состояние доступности «Отменено», когда покупатель предоставил запрос на отмену до того, как продавец предоставил ответ о доступности для всех строк.
STATE_EXPIRED Состояние «Истекшая доступность» означает, что срок действия заказа истек до того, как продавец завершил его.

Методы

complete

 Помечает существующий заказ доступности как завершенный.

get

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

list

 Список заказов на доступность.