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)

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

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

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)

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

Статус гарантированного заказа

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

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 .

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

Статус гарантированного заказа

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

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

Методы

create

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

editGuaranteedOrderReadAccessors

 Правки читают рекламодатели гарантированного заказа.

get

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

list

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

patch

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