REST Resource: guaranteedOrders

Ресурс: GuaranteedOrder

Гарантированный заказ.

Гарантированные заказы – это родительские объекты гарантированных источников инвентаря. При создании источника гарантированного инвентаря ему необходимо назначить идентификатор гарантированного заказа.

JSON-представление 
{
  "name": string,
  "legacyGuaranteedOrderId": string,
  "exchange": enum (Exchange),
  "guaranteedOrderId": string,
  "displayName": string,
  "status": {
    object (GuaranteedOrderStatus)
  },
  "updateTime": string,
  "publisherName": string,
  "readAccessInherited": boolean,
  "readAdvertiserIds": [
    string
  ],
  "defaultAdvertiserId": string,
  "defaultCampaignId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of mutually exclusive fields.
}
Поля
name

string

Только для вывода. Название ресурса гарантированного заказа.
legacyGuaranteedOrderId

string

Только для вывода. Устаревший идентификатор гарантированного заказа. Назначается исходной биржей. Устаревший идентификатор уникален в пределах одной биржи, но не обязательно уникален для всех гарантированных заказов. Этот идентификатор используется в SDF и интерфейсе.
exchange

enum (Exchange)

Обязательно. Не меняется. Биржа, на которой был создан гарантированный заказ.
guaranteedOrderId

string

Только для вывода. Уникальный идентификатор гарантированного заказа. Идентификаторы гарантированных заказов имеют формат {exchange}-{legacyGuaranteedOrderId}.
displayName

string

Обязательно. Отображаемое название гарантированного заказа.

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

object (GuaranteedOrderStatus)

Настройки статуса гарантированного заказа.
updateTime

string (Timestamp format)

Только для вывода. Временная метка последнего обновления гарантированного заказа. Назначается системой.

Используется формат RFC 3339. Результат всегда будет Z-нормализованным, и в нем будут использоваться цифры дробных частей 0, 3, 6 или 9. Допустимы и другие типы нормализации. Примеры: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30".
publisherName

string

Обязательно. Название издателя гарантированного заказа.

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

boolean

Есть ли у всех рекламодателей из readWritePartnerId доступ к гарантированному заказу в режиме чтения. Применимо, только если задано значение readWritePartnerId. Если задано значение True, переопределяет readAdvertiserIds.
readAdvertiserIds[]

string (int64 format)

Идентификаторы рекламодателей, у которых есть доступ к гарантированному заказу в режиме чтения.

Это поле не должно содержать рекламодателя, назначенного readWriteAdvertiserId, если он задан. Все рекламодатели в этом поле должны относиться к readWritePartnerId или к тому же партнеру, что и readWriteAdvertiserId.
defaultAdvertiserId

string (int64 format)

Только для вывода. Идентификатор рекламодателя по умолчанию, который относится к гарантированному заказу.

Рекламодатель по умолчанию – это либо readWriteAdvertiserId, либо, если он не задан, первый рекламодатель, указанный в readAdvertiserIds. В противном случае рекламодатель по умолчанию не назначается.
defaultCampaignId

string (int64 format)

Идентификатор кампании по умолчанию, назначенной гарантированному заказу.

Кампания по умолчанию должна относиться к рекламодателю по умолчанию.

Обязательно.

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

string (int64 format)

Партнер с доступом для чтения и записи к гарантированному заказу.
readWriteAdvertiserId

string (int64 format)

Рекламодатель с доступом для чтения и записи к гарантированному заказу. Он также будет рекламодателем по умолчанию для гарантированного заказа.
Конец взаимоисключающих полей.

GuaranteedOrderStatus

Настройки статуса гарантированного заказа.

JSON-представление 
{
  "entityStatus": enum (EntityStatus),
  "entityPauseReason": string,
  "configStatus": enum (GuaranteedOrderConfigStatus)
}
Поля
entityStatus

enum (EntityStatus)

Информация о том, можно ли показывать гарантированный заказ.

Допустимые значения: ENTITY_STATUS_ACTIVE, ENTITY_STATUS_ARCHIVED и ENTITY_STATUS_PAUSED. Значение по умолчанию – ENTITY_STATUS_ACTIVE.
entityPauseReason

string

Указанная пользователем причина приостановки гарантированного заказа.

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

Применяется, только если для entityStatus задано значение ENTITY_STATUS_PAUSED.
configStatus

enum (GuaranteedOrderConfigStatus)

Только для вывода. Статус конфигурации гарантированного заказа.

Допустимые значения: PENDING и COMPLETED.

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

GuaranteedOrderConfigStatus

Возможные состояния конфигурации гарантированного заказа.

Перечисления
GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED Статус рассмотрения не указан или неизвестен в этой версии.
PENDING Начальный статус гарантированного заказа. Гарантированный заказ в этом статусе необходимо настроить, прежде чем он сможет показываться.
COMPLETED Статус, который присваивается после того, как покупатель настроит гарантированный заказ.

Методы

create

 Создает новый гарантированный заказ.

editGuaranteedOrderReadAccessors

 Изменение рекламодателей, которые могут просматривать гарантированный заказ.

get

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

list

 Возвращает список гарантированных заказов, доступных текущему пользователю.

patch

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