REST Resource: orders.lines

Ресурс: Линия

Одна строка заказа, представляющая настроенный продукт.

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
}
Поля
name

string

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

product

string

Только вывод. Имя Product который настраивает эта строка. Формат = товары/123

externalId

string

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

displayName

string

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

description

string

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

lineState

enum ( LineState )

Только вывод. Состояние линии. См. LineState для получения информации о жизненном цикле линии.

Продавец может использовать следующие пользовательские методы: Reserve , Book и Reject чтобы установить один из следующих параметров:

  • LINE_STATE_RESERVED
  • LINE_STATE_BOOKED
  • LINE_STATE_REJECTED_BY_SELLER .

Все остальные состояния линий устанавливаются покупателем.

rejection

object ( Rejection )

Необязательный. Сведения об отклонении линии.

startTime
(deprecated)

string ( Timestamp format)

Только вывод. Когда линия начнет обслуживаться (включительно).

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

endTime
(deprecated)

string ( Timestamp format)

Только вывод. Когда линия перестанет обслуживаться (эксклюзивно).

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

startDate

object ( Date )

Только вывод. Дата начала обслуживания линии (включительно). Тот же часовой пояс, что и у рекламного блока.

endDate

object ( Date )

Только вывод. Дата прекращения обслуживания линии (включительно). Тот же часовой пояс, что и у рекламного блока.

budget

object ( Money )

Только вывод. Бюджет линии.

lineTerms

object ( LineTerms )

Только вывод. Гарантированные условия продавца по данной линии.

pendingReservationExpirationTime

string ( Timestamp format)

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

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

reservationExpirationTime

string ( Timestamp format)

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

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

targeting

object ( Targeting )

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

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

Линестате

Состояние линии.

Перечисления
LINE_STATE_UNSPECIFIED Значение по умолчанию, когда состояние линии не указано или неизвестно в этой версии.
LINE_STATE_PENDING_RESERVATION Линия была создана покупателем и требует резервирования продуктов, а также обновления информации о ценах и наличии.
LINE_STATE_RESERVED Линия была зарезервирована продавцом. Это состояние возможно только в том случае, если предыдущее состояние ожидает резервирования.
LINE_STATE_PENDING_BOOKING Покупатель принял резервирование и запрашивает резервирование линии.
LINE_STATE_BOOKED Продавец забронировал линию. Это состояние возможно только в том случае, если предыдущее состояние ожидает бронирования. На данном этапе отказов не ожидается.
LINE_STATE_REJECTED_BY_SELLER Линия была отклонена продавцом. Это состояние возможно только в том случае, если предыдущее состояние ожидает резервирования.
LINE_STATE_CANCELLED_BY_BUYER Линия была отменена покупателем.
LINE_STATE_PENDING_RESERVATION_EXPIRED Срок действия линии истек во время ожидания резервирования.
LINE_STATE_RESERVED_EXPIRED Срок действия линии истек, пока она зарезервирована, ожидается ответ покупателя.

Методы

book

 Бронирует существующую линию.

get

 Получает отдельную строку для заказа.

list

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

patch

 Обновляет существующую строку.

reject

 Отклоняет существующую строку.

reserve

 Резервирует существующую линию.