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,

  // Union field read_write_accessor can be only one of the following:
  "readWritePartnerId": string,
  "readWriteAdvertiserId": string
  // End of list of possible types for union field read_write_accessor.
}
Поля
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 знаков после запятой. Также допускаются смещения, отличные от «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)

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

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

Поле объединения read_write_accessor . Обязательно.

Партнер или рекламодатель с доступом на чтение/запись к гарантированному заказу. read_write_accessor может быть только одним из следующих:

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

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