- Ресурс: LineItem
- LineItemType
- LineItemПолет
- LineItemFlightDateType
- ПозицияБюджет
- LineItemBudgetAllocationType
- Партнерская модель дохода
- PartnerRevenueModelMarkupType
- ConversionCountingConfig
- ОтслеживаниеFloodlightActivityConfig
- LineItemПредупреждениеСообщение
- Мобильное приложение
- Платформа
- Настройки YoutubeAndPartners
- Конфигурации ThirdPartyMeasurementConfigs
- ThirdPartyVendorConfig
- Третья сторонаПоставщик
- YoutubeAndPartnersInventorySourceConfig
- YoutubeAndPartnersContentCategory
- Целевая частота
- Настройки последовательности видеообъявлений
- VideoAdSequenceMinimumDuration
- Шаг последовательности видеообъявлений
- Тип взаимодействия
- Методы
Ресурс: LineItem
Одна позиция.
JSON-представление |
---|
{ "name": string, "advertiserId": string, "campaignId": string, "insertionOrderId": string, "lineItemId": string, "displayName": string, "lineItemType": enum ( |
Поля | |
---|---|
name | Только вывод. Имя ресурса позиции. |
advertiser Id | Только вывод. Уникальный идентификатор рекламодателя, которому принадлежит позиция. |
campaign Id | Только вывод. Уникальный идентификатор кампании, к которой принадлежит позиция. |
insertion Order Id | Необходимый. Неизменяемый. Уникальный идентификатор заказа на размещение, к которому принадлежит позиция. |
line Item Id | Только вывод. Уникальный идентификатор позиции. Назначается системой. |
display Name | Необходимый. Отображаемое название позиции. Должен быть в кодировке UTF-8 с максимальным размером 240 байт. |
line Item Type | Необходимый. Неизменяемый. Тип позиции. |
entity Status | Необходимый. Определяет, может ли позиция расходовать свой бюджет и делать ставки на инвентарь.
|
update Time | Только вывод. Временная метка последнего обновления позиции. Назначается системой. Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: |
partner Costs[] | Расходы партнера, связанные с кампанией. Если метод |
flight | Необходимый. Время начала и окончания периода действия позиции. |
budget | Необходимый. Настройка распределения бюджета позиции. |
pacing | Необходимый. Настройка скорости расходования бюджета позиции. |
frequency Cap | Необходимый. Настройки ограничения частоты показов для позиции. Поле |
partner Revenue Model | Необходимый. Параметр партнерской модели дохода для позиции. |
conversion Counting | Настройка отслеживания конверсий позиции. |
creative Ids[] | Идентификаторы объявлений, связанных с позицией. |
bid Strategy | Необходимый. Стратегия назначения ставок для позиции. |
integration Details | Подробности интеграции позиции. |
targeting Expansion | Оптимизированные настройки таргетинга позиции. Эта конфигурация применима только к медийным, видео- и аудиопозициям, в которых используется автоматическое назначение ставок и таргетинг на списки подходящей аудитории. |
warning Messages[] | Только вывод. Предупреждающие сообщения, создаваемые кампанией. Эти предупреждения не блокируют сохранение позиции, но некоторые из них могут блокировать ее запуск. |
mobile App | Мобильное приложение, рекламируемое позицией. Это применимо только в том случае, если |
reservation Type | Только вывод. Тип резервирования позиции. |
exclude New Exchanges | Следует ли исключить новые биржи из автоматического таргетинга позиции. По умолчанию это поле имеет значение false. |
youtube And Partners Settings | Только вывод. Настройки, специфичные для позиций YouTube и партнерских программ. |
LineItemType
Возможные типы позиции.
Тип позиции определяет, какие настройки и параметры применимы, например формат объявлений или параметры таргетинга.
Перечисления | |
---|---|
LINE_ITEM_TYPE_UNSPECIFIED | Значение типа не указано или неизвестно в этой версии. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_DISPLAY_DEFAULT | Графические, HTML5, нативные или мультимедийные объявления. |
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL | Показывайте рекламу, которая увеличивает количество установок приложения. |
LINE_ITEM_TYPE_VIDEO_DEFAULT | Видеореклама продается по цене за тысячу показов для различных сред. |
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL | Видеореклама, которая увеличивает количество установок приложения. |
LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY | Медийная реклама, показываемая на инвентаре мобильных приложений. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY | Видеореклама показывается на инвентаре мобильных приложений. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_AUDIO_DEFAULT | Аудиообъявления RTB, продаваемые для различных сред. |
LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP | Чрезмерная реклама присутствует в заказах на размещение OTT. Этот тип применим только к позициям с заказом на размещение insertionOrderType OVER_THE_TOP . |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION | Видеообъявления YouTube, способствующие конверсиям. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE | Видеореклама YouTube (до 15 секунд), которую нельзя пропустить. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE | Видеореклама на YouTube, показывающая историю в определенной последовательности и в разных форматах. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO | Аудиореклама на YouTube. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH | Видеообъявления YouTube, которые оптимизируют охват большего количества уникальных пользователей по более низкой цене. Могут включать объявления-заставки, объявления In-Stream с возможностью пропуска или сочетание типов. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE | Видеореклама YouTube по умолчанию. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP | Подключенное ТВ на YouTube видеореклама (до 15 секунд), которую невозможно пропустить. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP | Видеореклама на YouTube, подключенная к телевизору, которая оптимизирует охват большего количества уникальных пользователей при меньших затратах. Могут включать объявления-заставки, объявления In-Stream с возможностью пропуска или сочетание типов. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP | Видеореклама YouTube по умолчанию для подключенного телевизора. Включайте только формат объявлений In-Stream. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY | Цель этого типа позиции — показать целевое количество объявлений YouTube одному и тому же человеку за определенный период времени. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW | Видеореклама на YouTube, целью которой является получение большего количества просмотров с помощью различных форматов рекламы. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME | Медийная реклама показывается на цифровых ресурсах вне дома. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME | Видеореклама показывается на цифровых ресурсах вне дома. Позиции этого типа и их таргетинг нельзя создавать или обновлять с помощью API. |
LineItemПолет
Настройки, управляющие активной продолжительностью позиции.
JSON-представление |
---|
{ "flightDateType": enum ( |
Поля | |
---|---|
flight Date Type | Необходимый. Тип дат окончания действия позиции. |
date Range | Даты начала и окончания периода действия позиции. Они разрешаются относительно часового пояса родительского рекламодателя.
|
LineItemFlightDateType
Возможные типы дат окончания действия позиции.
Перечисления | |
---|---|
LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED | Значение типа не указано или неизвестно в этой версии. |
LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED | Даты выполнения позиции наследуются из родительского заказа на размещение. |
LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM | В позиции используются собственные даты начала показа. |
ПозицияБюджет
Настройки, управляющие распределением бюджета.
JSON-представление |
---|
{ "budgetAllocationType": enum ( |
Поля | |
---|---|
budget Allocation Type | Необходимый. Тип распределения бюджета. |
budget Unit | Только вывод. Бюджетная единица определяет, основан ли бюджет на валюте или на показах. Это значение наследуется от родительского заказа на размещение. |
max Amount | Максимальная сумма бюджета, которую потратит позиция. Должно быть больше 0. Когда
|
LineItemBudgetAllocationType
Возможные виды распределения бюджета.
Перечисления | |
---|---|
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED | Значение типа не указано или неизвестно в этой версии. |
LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC | Для позиции включено автоматическое распределение бюджета. |
LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED | Для позиции выделяется фиксированная максимальная сумма бюджета. |
LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED | К позиции не применяется ограничение бюджета. |
Модель дохода партнера
Настройки, управляющие расчетом дохода партнера.
JSON-представление |
---|
{
"markupType": enum ( |
Поля | |
---|---|
markup Type | Необходимый. Тип наценки партнерской модели дохода. |
markup Amount | Необходимый. Сумма наценки партнерской модели дохода. Должно быть больше или равно 0.
|
PartnerRevenueModelMarkupType
Возможные типы наценок партнерской модели дохода.
Перечисления | |
---|---|
PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED | Значение типа не указано или неизвестно в этой версии. |
PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM | Рассчитайте доход партнера на основе фиксированной цены за тысячу показов. |
PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP | Рассчитайте доход партнера на основе процентной надбавки к стоимости рекламы. |
PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP | Рассчитайте доход партнера на основе процентной надбавки к общей стоимости рекламы, которая включает все партнерские расходы и затраты на передачу данных. |
ConversionCountingConfig
Настройки, управляющие подсчетом конверсий.
Все конверсии после клика будут засчитаны. Для подсчета конверсий после просмотра можно установить процентное значение.
JSON-представление |
---|
{
"postViewCountPercentageMillis": string,
"floodlightActivityConfigs": [
{
object ( |
Поля | |
---|---|
post View Count Percentage Millis | Процент учитываемых конверсий после просмотра, в миллисах (1/1000 процента). Должно быть от 0 до 100 000 включительно. Например, чтобы отслеживать 50 % конверсий после клика, установите значение 50 000. |
floodlight Activity Configs[] | Конфигурации действий Floodlight, используемые для отслеживания конверсий. Количество подсчитанных конверсий представляет собой сумму всех конверсий, подсчитанных всеми идентификаторами действий Floodlight, указанными в этом поле. |
ОтслеживаниеFloodlightActivityConfig
Настройки, управляющие поведением отдельной конфигурации действия Floodlight.
JSON-представление |
---|
{ "floodlightActivityId": string, "postClickLookbackWindowDays": integer, "postViewLookbackWindowDays": integer } |
Поля | |
---|---|
floodlight Activity Id | Необходимый. Идентификатор действия Floodlight. |
post Click Lookback Window Days | Необходимый. Количество дней после клика по объявлению, в течение которых может быть засчитана конверсия. Должно быть от 0 до 90 включительно. |
post View Lookback Window Days | Необходимый. Количество дней после просмотра объявления, в течение которых может быть засчитана конверсия. Должно быть от 0 до 90 включительно. |
LineItemПредупреждениеСообщение
Предупреждающие сообщения, создаваемые кампанией. Эти типы предупреждений не блокируют сохранение позиции, но могут блокировать ее запуск.
Перечисления | |
---|---|
LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED | Не указано или неизвестно. |
INVALID_FLIGHT_DATES | Для этой позиции указаны недопустимые даты полета. Позиция не будет показываться. |
EXPIRED | Дата окончания этой позиции уже в прошлом. |
PENDING_FLIGHT | Показ этой позиции начнется в будущем. |
ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED | Все партнерские биржи настроены негативно. Позиция не будет показываться. |
INVALID_INVENTORY_SOURCE | Ни один активный источник инвентаря не выбран. Позиция не будет показываться. |
APP_INVENTORY_INVALID_SITE_TARGETING | Таргетинг этой позиции на приложения и URL-адреса не включает мобильные приложения. Для этого типа позиции необходимо включить мобильные приложения в таргетинг на канал, список сайтов или приложения. Позиция не будет показываться. |
APP_INVENTORY_INVALID_AUDIENCE_LISTS | Эта позиция не ориентирована ни на одного мобильного пользователя. Для этого типа позиции необходимо настроить таргетинг на список пользователей мобильных устройств. Позиция не будет показываться. |
NO_VALID_CREATIVE | Эта позиция не содержит действительных объявлений. Позиция не будет показываться. |
PARENT_INSERTION_ORDER_PAUSED | Заказ на размещение этой позиции приостановлен. Позиция не будет показываться. |
PARENT_INSERTION_ORDER_EXPIRED | Дата окончания заказа на размещение этой позиции установлена в прошлом. Позиция не будет показываться. |
Мобильное приложение
Мобильное приложение, рекламируемое с помощью позиции установки мобильного приложения.
JSON-представление |
---|
{
"appId": string,
"platform": enum ( |
Поля | |
---|---|
app Id | Необходимый. Идентификатор приложения, предоставленный магазином платформы. Приложения Android идентифицируются по идентификатору пакета, используемому магазином Android Play, например Приложения iOS идентифицируются по девятизначному идентификатору приложения, используемому магазином приложений Apple, например |
platform | Только вывод. Платформа приложений. |
display Name | Только вывод. Имя приложения. |
publisher | Только вывод. Издатель приложения. |
Платформа
Возможные платформы мобильных приложений.
Перечисления | |
---|---|
PLATFORM_UNSPECIFIED | Платформа не указана. |
IOS | iOS-платформа. |
ANDROID | Платформа Андроид. |
Настройки YoutubeAndPartners
Настройки для позиций YouTube и партнерских программ.
JSON-представление |
---|
{ "viewFrequencyCap": { object ( |
Поля | |
---|---|
view Frequency Cap | Настройки ограничения частоты показов позиции. Поле |
third Party Measurement Configs | Необязательный. Сторонние конфигурации отслеживания позиции. |
inventory Source Settings | Настройки, определяющие, на какие ресурсы YouTube и партнеров будет нацелена позиция. |
content Category | Тип контента, на котором будет показываться реклама YouTube и партнеров. |
effective Content Category | Только вывод. Категория контента, которая вступает в силу при показе позиции. Если категория контента задана и для позиции, и для рекламодателя, при показе позиции будет действовать более строгая из них. |
target Frequency | Необязательный. Среднее количество раз, которое вы хотите, чтобы объявления из этой позиции показывались одному и тому же человеку за определенный период времени. |
linked Merchant Id | Необязательный. Идентификатор продавца, связанного с позицией фида товаров. |
related Video Ids[] | Необязательный. Идентификаторы видеороликов отображаются под основным видеообъявлением, когда оно воспроизводится в приложении YouTube на мобильных устройствах. |
lead Form Id | Необязательный. Идентификатор формы для привлечения потенциальных клиентов. |
video Ad Sequence Settings | Необязательный. Настройки, связанные с VideoAdSequence. |
Конфигурации ThirdPartyMeasurementConfigs
Настройки, которые определяют, какие сторонние поставщики измеряют конкретные показатели позиции.
JSON-представление |
---|
{ "viewabilityVendorConfigs": [ { object ( |
Поля | |
---|---|
viewability Vendor Configs[] | Необязательный. Сторонние поставщики, измеряющие видимость. Применимы следующие сторонние поставщики:
|
brand Safety Vendor Configs[] | Необязательный. Сторонние поставщики, измеряющие безопасность бренда. Применимы следующие сторонние поставщики:
|
reach Vendor Configs[] | Необязательный. Сторонние поставщики, измеряющие охват. Применимы следующие сторонние поставщики:
|
brand Lift Vendor Configs[] | Необязательный. Сторонние поставщики, измеряющие эффективность бренда. Применимы следующие сторонние поставщики:
|
ThirdPartyVendorConfig
Параметры, управляющие настройкой сторонних поставщиков средств измерения.
JSON-представление |
---|
{
"vendor": enum ( |
Поля | |
---|---|
vendor | Сторонний поставщик средств измерения. |
placement Id | Идентификатор, используемый платформой стороннего поставщика для идентификации позиции. |
Третья сторонаПоставщик
Поставщики, выполняющие сторонние измерения.
Перечисления | |
---|---|
THIRD_PARTY_VENDOR_UNSPECIFIED | Неизвестный сторонний поставщик. |
THIRD_PARTY_VENDOR_MOAT | Ров. |
THIRD_PARTY_VENDOR_DOUBLE_VERIFY | Даблверифи. |
THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE | Интегральная рекламная наука. |
THIRD_PARTY_VENDOR_COMSCORE | Комскор. |
THIRD_PARTY_VENDOR_TELEMETRY | Телеметрия. |
THIRD_PARTY_VENDOR_MEETRICS | Метрики. |
THIRD_PARTY_VENDOR_ZEFR | ЗЕФР. |
THIRD_PARTY_VENDOR_NIELSEN | Нильсен. |
THIRD_PARTY_VENDOR_KANTAR | Кантар. |
THIRD_PARTY_VENDOR_DYNATA | Дината. |
YoutubeAndPartnersInventorySourceConfig
Настройки, определяющие, на какие ресурсы, связанные с YouTube, будет ориентирована позиция YouTube и партнеры.
JSON-представление |
---|
{ "includeYoutube": boolean, "includeGoogleTv": boolean, "includeYoutubeVideoPartners": boolean } |
Поля | |
---|---|
include Youtube | Необязательный. Стоит ли настраивать таргетинг на инвентарь на YouTube. Сюда входит и поиск, и каналы, и видео. |
include Google Tv | Необязательный. Следует ли настраивать таргетинг на инвентарь в видеоприложениях, доступных с помощью Google TV. |
include Youtube Video Partners | Следует ли нацеливать инвентарь на ряд партнерских сайтов и приложений, которые соответствуют тем же стандартам безопасности бренда, что и YouTube. |
YoutubeAndPartnersContentCategory
Категории безопасности бренда для контента YouTube и партнеров.
Перечисления | |
---|---|
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED | Категория контента в этой версии не указана или неизвестна. |
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD | Категория, состоящая из широкого спектра контента, подходящего для большинства брендов. Контент основан на правилах YouTube в отношении контента, ориентированного на рекламодателей . |
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED | Категория, включающая весь контент YouTube и видеопартнеров, соответствующий стандартам монетизации. |
YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED | Категория, состоящая из ограниченного набора контента, отвечающего повышенным требованиям, особенно в отношении ненормативной лексики и сексуального содержания. |
Целевая частота
Настройка, определяющая среднее количество показов рекламы одному и тому же человеку за определенный период времени.
JSON-представление |
---|
{
"targetCount": string,
"timeUnit": enum ( |
Поля | |
---|---|
target Count | Целевое количество раз, в среднем, реклама будет показана одному и тому же человеку в интервале времени, определяемом |
time Unit | Единица времени, в течение которой будет применяться целевая частота. Применимы следующие единицы времени:
|
time Unit Count | Количество В зависимости от значения
|
Настройки последовательности видеообъявлений
Настройки, связанные с VideoAdSequence.
JSON-представление |
---|
{ "minimumDuration": enum ( |
Поля | |
---|---|
minimum Duration | Минимальный интервал времени, прежде чем тот же пользователь снова увидит эту последовательность. |
steps[] | Шаги, из которых состоит последовательность. |
VideoAdSequenceMinimumDuration
Перечисление возможного минимального интервала времени, прежде чем тот же пользователь снова увидит VideoAdSequence.
Перечисления | |
---|---|
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED | Неопределенный или неизвестный. |
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK | 7 дней. |
VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH | 30 дней. |
Шаг последовательности видеообъявлений
Подробности одного шага в VideoAdSequence.
JSON-представление |
---|
{
"stepId": string,
"adGroupId": string,
"previousStepId": string,
"interactionType": enum ( |
Поля | |
---|---|
step Id | Идентификатор шага. |
ad Group Id | Идентификатор соответствующей группы объявлений шага. |
previous Step Id | Идентификатор предыдущего шага. Первый шаг не имеет предыдущего шага. |
interaction Type | Взаимодействие на предыдущем шаге, которое приведет зрителя к этому шагу. Первый шаг не имеет тип взаимодействия. |
Тип взаимодействия
Виды взаимодействия на шаге.
Перечисления | |
---|---|
INTERACTION_TYPE_UNSPECIFIED | Неопределенный или неизвестный |
INTERACTION_TYPE_PAID_VIEW | Платный просмотр. |
INTERACTION_TYPE_SKIP | Пропущено зрителем. |
INTERACTION_TYPE_IMPRESSION | (Просмотренный) показ рекламы. |
INTERACTION_TYPE_ENGAGED_IMPRESSION | Показ рекламы, который не был сразу пропущен зрителем, но и не дошел до оплачиваемого события. |
Методы | |
---|---|
| Массовое изменение параметров таргетинга в нескольких позициях. |
| Перечисляет назначенные параметры таргетинга для нескольких позиций по типам таргетинга. |
| Обновляет несколько позиций. |
| Создает новую позицию. |
| Удаляет позицию. |
| Дублирует позицию. |
| Создает новую позицию с настройками (включая таргетинг) entity_status унаследованными от заказа на размещение, и ENTITY_STATUS_DRAFT . |
| Получает позицию. |
| Перечисляет позиции рекламодателя. |
| Обновляет существующую позицию. |