Линейный API динамической вставки объявлений

API динамической вставки рекламы позволяет запрашивать и отслеживать линейные (LIVE) потоки DAI.

Сервис: dai.google.com

Все URI являются относительными по отношению к https://dai.google.com

Метод: поток

Методы
stream POST /linear/v1/hls/event/{assetKey}/stream

Создает поток DAI для заданного идентификатора события.

HTTP-запрос 

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream

заголовок запроса

Параметры
api‑key string

Ключ API, предоставленный при создании потока, должен быть действителен для сети издателя.

Вместо того чтобы указывать ключ API в теле запроса, его можно передать в заголовке HTTP Authorization в следующем формате:

Authorization: DCLKDAI key="<api-key>"

Параметры пути

Параметры
assetKey string

Идентификатор события потока.
Примечание: Ключ ресурса потока — это идентификатор, который также можно найти в пользовательском интерфейсе Ad Manager .

Текст запроса

Тело запроса имеет тип application/x-www-form-urlencoded и содержит следующие параметры:

Параметры
dai-ssb Необязательный

Установите значение true , чтобы создать поток отправки сигналов на стороне сервера. По умолчанию — false . Отслеживание потока по умолчанию инициируется клиентом и отправляется на сервер.

Параметры таргетинга DFP Необязательный Дополнительные параметры наведения.
Переопределение параметров потока Необязательный Переопределить значения по умолчанию параметра создания потока.
Аутентификация HMAC Необязательный Аутентификация осуществляется с помощью токена на основе HMAC.

Ответный текст

В случае успеха тело ответа содержит новый Stream . Для потоков, отправляемых на стороне сервера, этот Stream содержит только поля stream_id и stream_manifest .

Открытое измерение

API DAI содержит информацию для проверки Open Measurement в поле Verifications . Это поле содержит один или несколько элементов Verification , в которых перечислены ресурсы и метаданные, необходимые для выполнения стороннего кода измерения с целью проверки воспроизведения креативов. Поддерживается только JavaScriptResource . Для получения дополнительной информации см. IAB Tech Lab и спецификацию VAST 4.1 .

Метод: проверка СМИ

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

Запросы к конечной точке media verification являются идемпотентными.

Методы
media verification GET /{media_verification_url}/{ad_media_id}

Уведомляет API о событии проверки носителя.

HTTP-запрос 

GET https://{media-verification-url}/{ad-media-id}

Ответный текст

media verification возвращаются следующие данные:

  • HTTP/1.1 204 No Content если проверка медиафайлов прошла успешно и все пинги отправлены.
  • HTTP/1.1 404 Not Found , если запрос не может проверить медиафайл из-за неправильного форматирования URL-адреса или истечения срока действия.
  • HTTP/1.1 404 Not Found если предыдущий запрос на проверку этого идентификатора был успешным.
  • HTTP/1.1 409 Conflict если в данный момент другой запрос уже отправляет пинги.

Идентификаторы рекламных медиа (HLS)

Идентификаторы рекламных медиафайлов будут закодированы в HLS Timed Metadata с использованием ключа TXXX , зарезервированного для фреймов с "текстовой информацией, определяемой пользователем". Содержимое фрейма будет незашифрованным и всегда будет начинаться с текста "google_" .

Весь текст содержимого фрейма следует добавить к URL-адресу подтверждения объявления перед отправкой каждого запроса на подтверждение объявления.

Метод: метаданные

Конечная точка метаданных по адресу metadata_url возвращает информацию, используемую для построения рекламного интерфейса. Конечная точка метаданных недоступна для потоков, передающих данные на стороне сервера, где сервер отвечает за инициирование проверки рекламного контента.

Методы
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

Получает информацию о метаданных рекламы.

HTTP-запрос 

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

Параметры запроса

Параметры
delta_token необязательный string

Непрозрачный токен, представляющий текущее состояние синхронизации клиента. Если он указан, сервер возвращает только метаданные, изменившиеся с момента генерации токена, а также новый next_delta_token в ответе. Если он опущен, сервер возвращает полные метаданные для всего окна DVR.

Ответный текст

В случае успеха ответ возвращает экземпляр PodMetadata .

Работа с метаданными

Метаданные состоят из трех отдельных разделов: tags , ads и рекламные breaks . Точкой входа в данные является раздел tags . Оттуда нужно пройтись по тегам и найти первую запись, имя которой является префиксом идентификатора рекламного ролика, найденного в видеопотоке. Например, идентификатор рекламного ролика может выглядеть так:

google_1234567890

Затем вы находите объект тега с именем google_12345 . В данном случае он соответствует идентификатору вашего рекламного носителя. Как только вы найдете правильный объект префикса рекламного носителя, вы можете выполнить поиск идентификаторов объявлений, идентификаторов рекламных пауз и типа события. Идентификаторы объявлений затем используются для индексации объектов ads , а идентификаторы рекламных пауз — для индексации объектов breaks .

Данные ответа

Транслировать

Объект Stream используется для отображения списка ресурсов для вновь созданного потока в формате JSON.
JSON-представление 
{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}
Поля
stream_id string

Идентификатор потока GAM.
stream_manifest string

URL-адрес манифеста потока, используемый для получения многовариантного плейлиста в HLS или MPD в DASH.
hls_master_playlist string

(УСТАРЕЛО) URL многовариантного плейлиста HLS. Используйте вместо него "stream_manifest".
media_verification_url string

URL-адрес для проверки медиафайлов, используемый в качестве базовой конечной точки для отслеживания событий воспроизведения.
metadata_url string

URL-адрес метаданных, используемый для периодического получения информации о предстоящих рекламных событиях в потоке.
session_update_url string

URL-адрес обновления сессии, используемый для обновления параметров таргетинга для этого потока. Исходные значения параметров таргетинга фиксируются во время первоначального запроса на создание потока.
polling_frequency number

Частота опроса в секундах при запросе metadata_url или heartbeat_url.

PodMetadata

PodMetadata содержит метаданные о рекламе, рекламных паузах и идентификаторах медиафайлов.
JSON-представление 
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "next_delta_token": string,
  "obsolete_ad_break_ids": [],
}
Поля
tags map[string, object(TagSegment)]

Карта сегментов тегов, проиндексированных по префиксу тега.
ads map[string, object(Ad)]

Карта объявлений, проиндексированных по идентификатору объявления.
ad_breaks map[string, object(AdBreak)]

Карта рекламных пауз, отсортированных по идентификатору рекламной паузы.
next_delta_token string

Непрозрачный токен, который клиент сможет использовать в следующем опросе.
obsolete_ad_break_ids string

Список идентификаторов рекламных пауз, которые устарели и должны быть удалены из кэша клиента.

TagSegment

TagSegment содержит ссылку на объявление, его рекламный блок и тип события. TagSegment с типом "progress" не должен отправляться на конечную точку проверки рекламного контента.
JSON-представление 
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Поля
ad string

Идентификатор объявления, к которому относится этот тег.
ad_break_id string

Идентификатор рекламного блока этого тега.
type string

Тип события этого тега.

AdBreak

AdBreak описывает одну рекламную паузу в потоке. Она содержит продолжительность, тип (в середине/перед/после) и количество рекламных объявлений.
JSON-представление 
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Поля
type string

Допустимые типы перерывов: до, во время и после.
duration number

Общая продолжительность рекламного блока в секундах.
expected_duration number

Ожидаемая продолжительность рекламной паузы (в секундах), включая все рекламные объявления и любые заставки.
ads number

Количество рекламных объявлений в рекламной паузе.
Ad описывает рекламное объявление в ленте.
JSON-представление
{
  "ad_break_id": string,
  "position": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
Поля
ad_break_id string

Идентификатор рекламного блока в этом объявлении.
position number

Позиция этого объявления в рекламной паузе, начиная с 1.
duration number

Продолжительность рекламного ролика в секундах.
title string

Заголовок объявления (необязательно).
description string

Дополнительное описание объявления.
advertiser string

Необязательный идентификатор рекламодателя.
ad_system string

Дополнительная рекламная система.
ad_id string

Необязательный идентификатор объявления.
creative_id string

Необязательный идентификатор креатива.
creative_ad_id string

Необязательный идентификатор креативного объявления.
deal_id string

Необязательный идентификатор сделки.
clickthrough_url string

Необязательный URL-адрес для перехода по ссылке.
click_tracking_urls string

Дополнительные URL-адреса для отслеживания кликов.
verifications [object(Verification)]

Дополнительные записи для проверки Open Measurement, в которых перечислены ресурсы и метаданные, необходимые для выполнения стороннего кода измерения с целью проверки воспроизведения креативов.
slate boolean

Необязательный логический параметр, указывающий, что текущая запись имеет значение "сланец".
icons [object(Icon)]

Список значков, опускается, если он пуст.
wrappers [object(Wrapper)]

Список оберток (Wrappers), опускается, если список пуст.
universal_ad_id object(UniversalAdID)

Дополнительный универсальный идентификатор объявления.
extensions string

Необязательный список всех узлов <Extension> в VAST.
companions [object(Companion)]

Дополнительные материалы, которые могут отображаться вместе с этим объявлением (по желанию).
interactive_file object(InteractiveFile)

Дополнительный интерактивный креатив (SIMID), который должен отображаться во время воспроизведения рекламы.

Икона

Icon содержит информацию об иконке VAST.
JSON-представление
{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}
Поля
click_data object(ClickData)

creative_type string

click_fallback_images [object(FallbackImage)]

height int32

width int32

resource string

type string

x_position string

y_position string

program string

alt_text string

ClickData

Данные ClickData содержат информацию о клике по значку.
JSON-представление
{
  "url": string,
}
Поля
url string

FallbackImage

FallbackImage содержит информацию о резервном образе VAST.
JSON-представление
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Поля
creative_type string

height int32

width int32

resource string

alt_text string

Упаковка

Wrapper содержит информацию о рекламном объявлении-оболочке. Он не включает идентификатор предложения (Deal ID), если он отсутствует.
JSON-представление
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Поля
system string

Идентификатор рекламной системы.
ad_id string

Идентификатор объявления, используемый для рекламной оболочки.
creative_id string

Для рекламного объявления-оболочки использован Creative ID.
creative_ad_id string

Идентификатор креатива, используемый для рекламного объявления-оболочки.
deal_id string

Необязательный идентификатор сделки для рекламного объявления-оболочки.

Проверка

В разделе «Верификация» содержится информация для Open Measurement, которая упрощает измерение видимости и верификацию сторонними сервисами. В настоящее время поддерживаются только ресурсы JavaScript. См. https://iabtechlab.com/standards/open-measurement-sdk/
JSON-представление
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Поля
vendor string

Поставщик услуг по проверке.
java_script_resources [object(JavaScriptResource)]

Список ресурсов JavaScript для проверки.
tracking_events [object(TrackingEvent)]

Список событий отслеживания для проверки.
parameters string

Непрозрачная строка, передаваемая коду проверки начальной загрузки.

JavaScriptResource

JavaScriptResource содержит информацию для проверки с помощью JavaScript.
JSON-представление
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Поля
script_url string

URI в JavaScript-код.
api_framework string

APIFramework — это название видеофреймворка, использующего код подтверждения.
browser_optional boolean

Можно ли запустить этот скрипт вне браузера?

Отслеживание событий

Класс TrackingEvent содержит URL-адреса, которые клиент должен проверять в определенных ситуациях.
JSON-представление
{
  "event": string,
  "uri": string,
}
Поля
event string

Тип события отслеживания.
uri string

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

UniversalAdID

UniversalAdID используется для предоставления уникального идентификатора рекламного креатива, который сохраняется во всех рекламных системах.
JSON-представление
{
  "id_value": string,
  "id_registry": string,
}
Поля
id_value string

Универсальный идентификатор объявления (Universal Ad ID) выбранного креатива для рекламы.
id_registry string

Строка, используемая для идентификации URL-адреса веб-сайта реестра, где каталогизирован универсальный идентификатор объявления выбранного рекламного материала.

Спутник

В разделе «Сопутствующие материалы» содержится информация о сопутствующих рекламных объявлениях, которые могут отображаться вместе с основным объявлением.
JSON-представление
{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}
Поля
click_data object(ClickData)

Данные о кликах по этому сопутствующему товару.
creative_type string

Атрибут CreativeType у узла <StaticResource> в VAST указывает, является ли он компонентом типа static.
height int32

Высота этого спутника в пикселях.
width int32

Ширина этого компаньона в пикселях.
resource string

Для статических элементов и элементов iframe это будет URL-адрес, который будет загружен и отображен. Для элементов HTML это будет фрагмент HTML-кода, который должен отображаться в качестве элемента.
type string

Тип этого дополнения. Оно может быть статическим, iframe или HTML.
ad_slot_id string

Идентификатор слота для этого компаньона.
api_framework string

API-фреймворк для этого дополнения.
tracking_events [object(TrackingEvent)]

Список событий отслеживания для этого компаньона.

Интерактивный файл

Файл InteractiveFile содержит информацию об интерактивном креативе (т.е. SIMID), который должен отображаться во время воспроизведения рекламы.
JSON-представление
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Поля
resource string

URL-адрес интерактивного рекламного материала.
type string

MIME-тип файла, предоставленного в качестве ресурса.
variable_duration boolean

Возможно ли, что автор данного творческого произведения попросит продлить срок действия?
ad_parameters string

Значение узла <AdParameters> в VAST.
,

API динамической вставки рекламы позволяет запрашивать и отслеживать линейные (LIVE) потоки DAI.

Сервис: dai.google.com

Все URI являются относительными по отношению к https://dai.google.com

Метод: поток

Методы
stream POST /linear/v1/hls/event/{assetKey}/stream

Создает поток DAI для заданного идентификатора события.

HTTP-запрос 

POST https://dai.google.com/linear/v1/hls/event/{assetKey}/stream

заголовок запроса

Параметры
api‑key string

Ключ API, предоставленный при создании потока, должен быть действителен для сети издателя.

Вместо того чтобы указывать ключ API в теле запроса, его можно передать в заголовке HTTP Authorization в следующем формате:

Authorization: DCLKDAI key="<api-key>"

Параметры пути

Параметры
assetKey string

Идентификатор события потока.
Примечание: Ключ ресурса потока — это идентификатор, который также можно найти в пользовательском интерфейсе Ad Manager .

Текст запроса

Тело запроса имеет тип application/x-www-form-urlencoded и содержит следующие параметры:

Параметры
dai-ssb Необязательный

Установите значение true , чтобы создать поток отправки сигналов на стороне сервера. По умолчанию — false . Отслеживание потока по умолчанию инициируется клиентом и отправляется на сервер.

Параметры таргетинга DFP Необязательный Дополнительные параметры наведения.
Переопределение параметров потока Необязательный Переопределить значения по умолчанию параметра создания потока.
Аутентификация HMAC Необязательный Аутентификация осуществляется с помощью токена на основе HMAC.

Ответный текст

В случае успеха тело ответа содержит новый Stream . Для потоков, отправляемых на стороне сервера, этот Stream содержит только поля stream_id и stream_manifest .

Открытое измерение

API DAI содержит информацию для проверки Open Measurement в поле Verifications . Это поле содержит один или несколько элементов Verification , в которых перечислены ресурсы и метаданные, необходимые для выполнения стороннего кода измерения с целью проверки воспроизведения креативов. Поддерживается только JavaScriptResource . Для получения дополнительной информации см. IAB Tech Lab и спецификацию VAST 4.1 .

Метод: проверка СМИ

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

Запросы к конечной точке media verification являются идемпотентными.

Методы
media verification GET /{media_verification_url}/{ad_media_id}

Уведомляет API о событии проверки носителя.

HTTP-запрос 

GET https://{media-verification-url}/{ad-media-id}

Ответный текст

media verification возвращаются следующие данные:

  • HTTP/1.1 204 No Content если проверка медиафайлов прошла успешно и все пинги отправлены.
  • HTTP/1.1 404 Not Found , если запрос не может проверить медиафайл из-за неправильного форматирования URL-адреса или истечения срока действия.
  • HTTP/1.1 404 Not Found если предыдущий запрос на проверку этого идентификатора был успешным.
  • HTTP/1.1 409 Conflict если в данный момент другой запрос уже отправляет пинги.

Идентификаторы рекламных медиа (HLS)

Идентификаторы рекламных медиафайлов будут закодированы в HLS Timed Metadata с использованием ключа TXXX , зарезервированного для фреймов с "текстовой информацией, определяемой пользователем". Содержимое фрейма будет незашифрованным и всегда будет начинаться с текста "google_" .

Весь текст содержимого фрейма следует добавить к URL-адресу подтверждения объявления перед отправкой каждого запроса на подтверждение объявления.

Метод: метаданные

Конечная точка метаданных по адресу metadata_url возвращает информацию, используемую для построения рекламного интерфейса. Конечная точка метаданных недоступна для потоков, передающих данные на стороне сервера, где сервер отвечает за инициирование проверки рекламного контента.

Методы
metadata GET /{metadata_url}/{ad-media-id}

GET /{metadata_url}

Получает информацию о метаданных рекламы.

HTTP-запрос 

GET https://{metadata_url}/{ad-media-id}

GET https://{metadata_url}

Параметры запроса

Параметры
delta_token необязательный string

Непрозрачный токен, представляющий текущее состояние синхронизации клиента. Если он указан, сервер возвращает только метаданные, изменившиеся с момента генерации токена, а также новый next_delta_token в ответе. Если он опущен, сервер возвращает полные метаданные для всего окна DVR.

Ответный текст

В случае успеха ответ возвращает экземпляр PodMetadata .

Работа с метаданными

Метаданные состоят из трех отдельных разделов: tags , ads и рекламные breaks . Точкой входа в данные является раздел tags . Оттуда нужно пройтись по тегам и найти первую запись, имя которой является префиксом идентификатора рекламного ролика, найденного в видеопотоке. Например, идентификатор рекламного ролика может выглядеть так:

google_1234567890

Затем вы находите объект тега с именем google_12345 . В данном случае он соответствует идентификатору вашего рекламного носителя. Как только вы найдете правильный объект префикса рекламного носителя, вы можете выполнить поиск идентификаторов объявлений, идентификаторов рекламных пауз и типа события. Идентификаторы объявлений затем используются для индексации объектов ads , а идентификаторы рекламных пауз — для индексации объектов breaks .

Данные ответа

Транслировать

Объект Stream используется для отображения списка ресурсов для вновь созданного потока в формате JSON.
JSON-представление 
{
  "stream_id": string,
  "stream_manifest": string,
  "hls_master_playlist": string,
  "media_verification_url": string,
  "metadata_url": string,
  "session_update_url": string,
  "polling_frequency": number,
}
Поля
stream_id string

Идентификатор потока GAM.
stream_manifest string

URL-адрес манифеста потока, используемый для получения многовариантного плейлиста в HLS или MPD в DASH.
hls_master_playlist string

(УСТАРЕЛО) URL многовариантного плейлиста HLS. Используйте вместо него "stream_manifest".
media_verification_url string

URL-адрес для проверки медиафайлов, используемый в качестве базовой конечной точки для отслеживания событий воспроизведения.
metadata_url string

URL-адрес метаданных, используемый для периодического получения информации о предстоящих рекламных событиях в потоке.
session_update_url string

URL-адрес обновления сессии, используемый для обновления параметров таргетинга для этого потока. Исходные значения параметров таргетинга фиксируются во время первоначального запроса на создание потока.
polling_frequency number

Частота опроса в секундах при запросе metadata_url или heartbeat_url.

PodMetadata

PodMetadata содержит метаданные о рекламе, рекламных паузах и идентификаторах медиафайлов.
JSON-представление 
{
  "tags": map[string, object(TagSegment)],
  "ads": map[string, object(Ad)],
  "ad_breaks": map[string, object(AdBreak)],
  "next_delta_token": string,
  "obsolete_ad_break_ids": [],
}
Поля
tags map[string, object(TagSegment)]

Карта сегментов тегов, проиндексированных по префиксу тега.
ads map[string, object(Ad)]

Карта объявлений, проиндексированных по идентификатору объявления.
ad_breaks map[string, object(AdBreak)]

Карта рекламных пауз, отсортированных по идентификатору рекламной паузы.
next_delta_token string

Непрозрачный токен, который клиент сможет использовать в следующем опросе.
obsolete_ad_break_ids string

Список идентификаторов рекламных пауз, которые устарели и должны быть удалены из кэша клиента.

TagSegment

TagSegment содержит ссылку на объявление, его рекламный блок и тип события. TagSegment с типом "progress" не должен отправляться на конечную точку проверки рекламного контента.
JSON-представление 
{
  "ad": string,
  "ad_break_id": string,
  "type": string,
}
Поля
ad string

Идентификатор объявления, к которому относится этот тег.
ad_break_id string

Идентификатор рекламного блока этого тега.
type string

Тип события этого тега.

AdBreak

AdBreak описывает одну рекламную паузу в потоке. Она содержит продолжительность, тип (в середине/перед/после) и количество рекламных объявлений.
JSON-представление 
{
  "type": string,
  "duration": number,
  "expected_duration": number,
  "ads": number,
}
Поля
type string

Допустимые типы перерывов: до, во время и после.
duration number

Общая продолжительность рекламного блока в секундах.
expected_duration number

Ожидаемая продолжительность рекламной паузы (в секундах), включая все рекламные объявления и любые заставки.
ads number

Количество рекламных объявлений в рекламной паузе.
Ad описывает рекламное объявление в ленте.
JSON-представление
{
  "ad_break_id": string,
  "position": number,
  "duration": number,
  "title": string,
  "description": string,
  "advertiser": string,
  "ad_system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
  "clickthrough_url": string,
  "click_tracking_urls": [],
  "verifications": [object(Verification)],
  "slate": boolean,
  "icons": [object(Icon)],
  "wrappers": [object(Wrapper)],
  "universal_ad_id": object(UniversalAdID),
  "extensions": [],
  "companions": [object(Companion)],
  "interactive_file": object(InteractiveFile),
}
Поля
ad_break_id string

Идентификатор рекламного блока в этом объявлении.
position number

Позиция этого объявления в рекламной паузе, начиная с 1.
duration number

Продолжительность рекламного ролика в секундах.
title string

Заголовок объявления (необязательно).
description string

Дополнительное описание объявления.
advertiser string

Необязательный идентификатор рекламодателя.
ad_system string

Дополнительная рекламная система.
ad_id string

Необязательный идентификатор объявления.
creative_id string

Необязательный идентификатор креатива.
creative_ad_id string

Необязательный идентификатор креативного объявления.
deal_id string

Необязательный идентификатор сделки.
clickthrough_url string

Необязательный URL-адрес для перехода по ссылке.
click_tracking_urls string

Дополнительные URL-адреса для отслеживания кликов.
verifications [object(Verification)]

Дополнительные записи для проверки Open Measurement, в которых перечислены ресурсы и метаданные, необходимые для выполнения стороннего кода измерения с целью проверки воспроизведения креативов.
slate boolean

Необязательный логический параметр, указывающий, что текущая запись имеет значение "сланец".
icons [object(Icon)]

Список значков, опускается, если он пуст.
wrappers [object(Wrapper)]

Список оберток (Wrappers), опускается, если список пуст.
universal_ad_id object(UniversalAdID)

Дополнительный универсальный идентификатор объявления.
extensions string

Необязательный список всех узлов <Extension> в VAST.
companions [object(Companion)]

Дополнительные материалы, которые могут отображаться вместе с этим объявлением (по желанию).
interactive_file object(InteractiveFile)

Дополнительный интерактивный креатив (SIMID), который должен отображаться во время воспроизведения рекламы.

Икона

Icon содержит информацию об иконке VAST.
JSON-представление
{
  "click_data": object(ClickData),
  "creative_type": string,
  "click_fallback_images": [object(FallbackImage)],
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "x_position": string,
  "y_position": string,
  "program": string,
  "alt_text": string,
}
Поля
click_data object(ClickData)

creative_type string

click_fallback_images [object(FallbackImage)]

height int32

width int32

resource string

type string

x_position string

y_position string

program string

alt_text string

ClickData

Данные ClickData содержат информацию о клике по значку.
JSON-представление
{
  "url": string,
}
Поля
url string

FallbackImage

FallbackImage содержит информацию о резервном образе VAST.
JSON-представление
{
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "alt_text": string,
}
Поля
creative_type string

height int32

width int32

resource string

alt_text string

Упаковка

Wrapper содержит информацию о рекламном объявлении-оболочке. Он не включает идентификатор предложения (Deal ID), если он отсутствует.
JSON-представление
{
  "system": string,
  "ad_id": string,
  "creative_id": string,
  "creative_ad_id": string,
  "deal_id": string,
}
Поля
system string

Идентификатор рекламной системы.
ad_id string

Идентификатор объявления, используемый для рекламной оболочки.
creative_id string

Для рекламного объявления-оболочки использован Creative ID.
creative_ad_id string

Идентификатор креатива, используемый для рекламного объявления-оболочки.
deal_id string

Необязательный идентификатор сделки для рекламного объявления-оболочки.

Проверка

В разделе «Верификация» содержится информация для Open Measurement, которая упрощает измерение видимости и верификацию сторонними сервисами. В настоящее время поддерживаются только ресурсы JavaScript. См. https://iabtechlab.com/standards/open-measurement-sdk/
JSON-представление
{
  "vendor": string,
  "java_script_resources": [object(JavaScriptResource)],
  "tracking_events": [object(TrackingEvent)],
  "parameters": string,
}
Поля
vendor string

Поставщик услуг по проверке.
java_script_resources [object(JavaScriptResource)]

Список ресурсов JavaScript для проверки.
tracking_events [object(TrackingEvent)]

Список событий отслеживания для проверки.
parameters string

Непрозрачная строка, передаваемая коду проверки начальной загрузки.

JavaScriptResource

JavaScriptResource содержит информацию для проверки с помощью JavaScript.
JSON-представление
{
  "script_url": string,
  "api_framework": string,
  "browser_optional": boolean,
}
Поля
script_url string

URI в JavaScript-код.
api_framework string

APIFramework — это название видеофреймворка, использующего код подтверждения.
browser_optional boolean

Можно ли запустить этот скрипт вне браузера?

Отслеживание событий

Класс TrackingEvent содержит URL-адреса, которые клиент должен проверять в определенных ситуациях.
JSON-представление
{
  "event": string,
  "uri": string,
}
Поля
event string

Тип события отслеживания.
uri string

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

UniversalAdID

UniversalAdID используется для предоставления уникального идентификатора рекламного креатива, который сохраняется во всех рекламных системах.
JSON-представление
{
  "id_value": string,
  "id_registry": string,
}
Поля
id_value string

Универсальный идентификатор объявления (Universal Ad ID) выбранного креатива для рекламы.
id_registry string

Строка, используемая для идентификации URL-адреса веб-сайта реестра, где каталогизирован универсальный идентификатор объявления выбранного рекламного материала.

Спутник

В разделе «Сопутствующие материалы» содержится информация о сопутствующих рекламных объявлениях, которые могут отображаться вместе с основным объявлением.
JSON-представление
{
  "click_data": object(ClickData),
  "creative_type": string,
  "height": int32,
  "width": int32,
  "resource": string,
  "type": string,
  "ad_slot_id": string,
  "api_framework": string,
  "tracking_events": [object(TrackingEvent)],
}
Поля
click_data object(ClickData)

Данные о кликах по этому сопутствующему товару.
creative_type string

Атрибут CreativeType у узла <StaticResource> в VAST указывает, является ли он компонентом типа static.
height int32

Высота этого спутника в пикселях.
width int32

Ширина этого компаньона в пикселях.
resource string

Для статических элементов и элементов iframe это будет URL-адрес, который будет загружен и отображен. Для элементов HTML это будет фрагмент HTML-кода, который должен отображаться в качестве элемента.
type string

Тип этого дополнения. Оно может быть статическим, iframe или HTML.
ad_slot_id string

Идентификатор слота для этого компаньона.
api_framework string

API-фреймворк для этого дополнения.
tracking_events [object(TrackingEvent)]

Список событий отслеживания для этого компаньона.

Интерактивный файл

Файл InteractiveFile содержит информацию об интерактивном креативе (т.е. SIMID), который должен отображаться во время воспроизведения рекламы.
JSON-представление
{
  "resource": string,
  "type": string,
  "variable_duration": boolean,
  "ad_parameters": string,
}
Поля
resource string

URL-адрес интерактивного рекламного материала.
type string

MIME-тип файла, предоставленного в качестве ресурса.
variable_duration boolean

Возможно ли, что автор данного творческого произведения попросит продлить срок действия?
ad_parameters string

Значение узла <AdParameters> в VAST.