REST Resource: advertisers.insertionOrders

Ресурс: InsertionOrder

Единый заказ на размещение.

JSON-представление
{
  "name": string,
  "advertiserId": string,
  "campaignId": string,
  "insertionOrderId": string,
  "displayName": string,
  "insertionOrderType": enum (InsertionOrderType),
  "entityStatus": enum (EntityStatus),
  "updateTime": string,
  "partnerCosts": [
    {
      object (PartnerCost)
    }
  ],
  "pacing": {
    object (Pacing)
  },
  "frequencyCap": {
    object (FrequencyCap)
  },
  "integrationDetails": {
    object (IntegrationDetails)
  },
  "performanceGoal": {
    object (PerformanceGoal)
  },
  "budget": {
    object (InsertionOrderBudget)
  },
  "bidStrategy": {
    object (BiddingStrategy)
  },
  "reservationType": enum (ReservationType),
  "billableOutcome": enum (BillableOutcome)
}
Поля
name

string

Только вывод. Название ресурса заказа на размещение.

advertiserId

string ( int64 format)

Только вывод. Уникальный идентификатор рекламодателя, которому принадлежит заказ на размещение.

campaignId

string ( int64 format)

Необходимый. Неизменный. Уникальный идентификатор кампании, которой принадлежит заказ на размещение.

insertionOrderId

string ( int64 format)

Только вывод. Уникальный идентификатор заказа на размещение. Назначается системой.

displayName

string

Необходимый. Отображаемое название заказа на размещение.

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

insertionOrderType

enum ( InsertionOrderType )

Тип заказа на размещение.

Если это поле не указано при создании, по умолчанию используется значение RTB .

entityStatus

enum ( EntityStatus )

Необходимый. Определяет, может ли заказ на размещение расходовать свой бюджет и делать ставки на инвентарь.

  • Для метода insertionOrders.create разрешен только ENTITY_STATUS_DRAFT . Чтобы активировать заказ на размещение, используйте метод insertionOrders.patch и обновите статус на ENTITY_STATUS_ACTIVE после создания.
  • Заказ на размещение нельзя вернуть обратно в статус ENTITY_STATUS_DRAFT из любого другого статуса.
  • Заказу на размещение нельзя установить значение ENTITY_STATUS_ACTIVE , если его родительская кампания неактивна.
updateTime

string ( Timestamp format)

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

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

partnerCosts[]

object ( PartnerCost )

Расходы партнера, связанные с заказом на размещение.

Если метод insertionOrders.create отсутствует или пуст, вновь созданный заказ на размещение унаследует партнерские расходы из настроек партнера.

pacing

object ( Pacing )

Необходимый. Настройка скорости расходования бюджета в заказе на размещение.

frequencyCap

object ( FrequencyCap )

Необходимый. Настройка ограничения частоты показов в заказе на размещение.

integrationDetails

object ( IntegrationDetails )

Дополнительные сведения об интеграции заказа на размещение.

performanceGoal

object ( PerformanceGoal )

Необходимый. Цель эффективности заказа на размещение.

budget

object ( InsertionOrderBudget )

Необходимый. Настройки распределения бюджета заказа на размещение.

bidStrategy

object ( BiddingStrategy )

Стратегия назначения ставок в заказе на размещение. По умолчанию установлена fixedBid .

reservationType

enum ( ReservationType )

Только вывод. Тип резервирования заказа на размещение.

billableOutcome

enum ( BillableOutcome )

Неизменный. Оплачиваемый результат заказа на размещение.

Покупка на основе результата устарела. BILLABLE_OUTCOME_PAY_PER_IMPRESSION — единственное допустимое значение.

Инсертинордертипе

Возможные типы заказа на размещение.

Тип заказа на размещение определяет, какие настройки и параметры применимы, например формат объявлений или параметры таргетинга.

Перечисления
INSERTION_ORDER_TYPE_UNSPECIFIED Тип заказа на размещение не указан или неизвестен.
RTB Торги в режиме реального времени.
OVER_THE_TOP Чрезмерно.

Бюджет заказа на вставку

Настройки, управляющие распределением бюджета заказа на размещение.

JSON-представление
{
  "budgetUnit": enum (BudgetUnit),
  "automationType": enum (InsertionOrderAutomationType),
  "budgetSegments": [
    {
      object (InsertionOrderBudgetSegment)
    }
  ]
}
Поля
budgetUnit

enum ( BudgetUnit )

Необходимый. Неизменный. Бюджетная единица определяет, основан ли бюджет на валюте или на показах.

automationType

enum ( InsertionOrderAutomationType )

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

Если это поле не указано при создании, значение по умолчанию равно INSERTION_ORDER_AUTOMATION_TYPE_NONE .

budgetSegments[]

object ( InsertionOrderBudgetSegment )

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

Инсерционордеравтоматионтипе

Возможные варианты автоматизации ставки и бюджета заказа на размещение.

Перечисления
INSERTION_ORDER_AUTOMATION_TYPE_UNSPECIFIED В этой версии опция автоматизации заказа на размещение не указана или неизвестна.
INSERTION_ORDER_AUTOMATION_TYPE_BUDGET Автоматическое распределение бюджета. Разрешите системе автоматически перераспределять бюджет на собственные позиции, чтобы оптимизировать эффективность, определенную performanceGoal . Никакой автоматизации в настройках ставок.
INSERTION_ORDER_AUTOMATION_TYPE_NONE Никакой автоматизации ставок или бюджета на уровне заказа на размещение. Ставку и бюджет необходимо настроить вручную на уровне позиции.
INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET Разрешите системе автоматически корректировать ставки и переносить бюджет на принадлежащие позиции, чтобы оптимизировать эффективность, определенную параметром performanceGoal .

Инсерционордербюджетсегмент

Настройки, управляющие бюджетом одного сегмента бюджета.

JSON-представление
{
  "budgetAmountMicros": string,
  "description": string,
  "dateRange": {
    object (DateRange)
  },
  "campaignBudgetId": string
}
Поля
budgetAmountMicros

string ( int64 format)

Необходимый. Сумма бюджета, которую заказ на размещение потратит за заданный dateRange . Сумма указана в микронах. Должно быть больше 0. Например, 500000000 представляет 500 стандартных единиц валюты.

description

string

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

Должно быть в кодировке UTF-8.

dateRange

object ( DateRange )

Необходимый. Настройки даты начала и окончания бюджетного сегмента. Они разрешаются относительно часового пояса родительского рекламодателя.

  • При создании нового сегмента бюджета startDate , и endDate должны находиться в будущем.
  • Существующий сегмент бюджета с startDate в прошлом имеет изменяемую endDate , но неизменяемую startDate .
  • endDate должна быть startDate или позже, оба до 2037 года.
campaignBudgetId

string ( int64 format)

budgetId бюджета кампании, частью которого является этот сегмент бюджета заказа на размещение.

Оплачиваемый результат

Возможные оплачиваемые результаты заказа на размещение.

Перечисления
BILLABLE_OUTCOME_UNSPECIFIED Неуказанный оплачиваемый результат.
BILLABLE_OUTCOME_PAY_PER_IMPRESSION Плата за показы.
BILLABLE_OUTCOME_PAY_PER_CLICK

Платите за клик.

BILLABLE_OUTCOME_PAY_PER_VIEWABLE_IMPRESSION

Плата за активный просмотр.

Методы

create

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

delete

 Удаляет заказ на размещение.

get

 Получает заказ на размещение.

list

 Перечисляет заказы на размещение у рекламодателя.

listAssignedTargetingOptions

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

patch

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