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 и UI.

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 дробных знаков. Допускаются также смещения, отличные от "Z". Примеры: "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)

Рекламодатель, имеющий доступ на чтение/запись к гарантированному ордеру. Это также рекламодатель по умолчанию для гарантированного ордера.

Конец взаимоисключающих областей.

ГарантированныйСтатусЗаказа

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

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

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