Добавление параметров таргетинга в потоковое видео

Все параметры таргетинга, перечисленные ниже, не являются обязательными.

Во время настройки источника контента для видео по запросу или прямой трансляции с динамической вставкой объявлений необходимо указать тег видеообъявления по умолчанию. Все видеопотоки с динамической вставкой объявлений будут использовать этот тег и его параметры. Параметры тегов объявлений применяются к видеорекламе как в середине, так и в начале ролика. Если вам нужно задать уникальные настройки для отдельного потокового видео, используйте параметры, перечисленные ниже.

Параметры тега объявления Менеджера рекламы, которые можно переопределить

Выберите нужный параметр:

addtl_consent an ciu_szs cust_params description_url gdpr gdpr_consent givn|paln idtype is_lat iu

iu is_lat ltd mpt mpv npa omid_p ppid ptpl ptpln rdid rdid

rdp sdk_apis sid sz tfcd trt vconp vpa vpmute wta

 

Переопределение параметров тега объявления

Когда ваш видеопроигрыватель запрашивает трансляцию, тег объявления по умолчанию используется в точном соответствии с заданными вами настройками. Однако вы можете переопределить некоторые параметры этого тега в запросе видеопотока. В таблице ниже приведен перечень таких параметров.

Подробнее о том, как переопределить параметры тега объявления с помощью IMA SDK или SSB…

Параметр	Описание	Пример значения
iu	Текущий рекламный блок. Корректный формат: /network_id/directory/ad_unit	iu=/6062/video/example_unit
cust_params	Пары "ключ-значение", используемые для таргетинга кампании Менеджера рекламы. Для некоторых платформ требуется кодирование URL. При использовании IMA SDK и DAI SDK для HTML5 кодировать URL не нужно, так как в этом случае кодирование выполняется автоматически. Этот параметр не будет работать, если он уже закодирован в HTML5.	В примерах ниже используются следующие пары "ключ-значение": section=sports page=golf,tennis   Видеопотоки с использованием маяков на сервере. Закодируйте и объедините в параметре cust_params все используемые значения. Следите за тем, чтобы не кодировать символы, которые уже являются частью кода. cust_params= "section%3Dsports %26page%3Dgolf%2Ctennis"   Chromecast. Кодировать нужно только значения. streamRequest. adTagParameters = { "cust_params": "section=sports& multi=golf%2Ctennis"};   Roku. Закодируйте и объедините в параметре cust_params все используемые значения. Следите за тем, чтобы не кодировать символы, которые уже являются частью кода. request.adTagParameters = "cust_params= section%3Dsports %26page%3Dgolf%2Ctennis"   iOS и tvOS. Ничего кодировать не нужно. request.adTagParameters = @{ @"cust_params" : @"section=sports& multi=golf,tennis"};   Android. Ничего кодировать не нужно. Map<String, String> adTagParams = new HashMap<>(); adTagParams.put( "cust_params", "ge=0&gr=2");
sz	Переопределяет параметр sz в вашем теге объявления по умолчанию, позволяя динамически выбирать подходящую по размеру рекламу для разных устройств. Не добавляйте букву v после размера.	sz=400x300
tfcd	Пометка запроса объявления, которое будет показываться на ресурсе для детей. Если запрос динамической вставки объявлений содержит tfcd=1, то все значения, присвоенные параметрам rdid, idtype или is_lat, удаляются. Это делается, чтобы обеспечить соблюдение закона COPPA.	tfcd=1
description_url	URL страницы с информацией о видео. Обычно это страница, на которой размещен проигрыватель, но можно указывать и страницу с описанием видео. Если параметр description_url применяется в видеопотоках SSB и при работе с IMA SDK и DAI SDK для платформы Roku, то URL в его значении нужно кодировать. Это требование не действует при работе с IMA SDK и DAI SDK для HTML5, так как в этом случае значение кодируется автоматически. Этот параметр не будет работать, если он уже закодирован в HTML5. IMA SDK не устанавливает этот параметр автоматически. Его требуется задавать вручную. Это поле обязательно, если вы используете Ad Exchange. Подробнее…	Пример с кодированием: description_url= http%3A%2F%2Fwww.sample.com %2Fgolf.html Пример без кодирования: description_url= http://www.sample.com/ golf.html
ppid	Идентификатор, назначаемый издателем, – это уникальная комбинация символов, которую отправляет издатель. Она используется для ограничения частоты показов, сегментирования аудитории, таргетинга, ротации объявлений и других способов управления рекламой на разных устройствах. Подробнее…	ppid= 12JD92J…
ciu_szs	Список форматов сопутствующих объявлений через запятую. Сопутствующие объявления поддерживает только HTML5 SDK с динамической вставкой.	ciu_szs=728x90,300x250
mpt	Название проигрывателя партнера. Обычно используется партнерами, предусматривающими интеграцию SDK, такими как JWPlayer, Brightcove и Ooyala.	mpt=JWPlayer
mpv	Версия проигрывателя, который используется партнером и поддерживает SDK. Задавать значение этого параметра следует, только если указан параметр mpt.	mpv=2.1
ptpl	Идентификатор шаблона рекламной паузы. Этот идентификатор можно найти в URL Менеджера рекламы при просмотре настроек шаблона рекламной паузы в его интерфейсе. Он представлен как значение параметра break_template_id.	ptpl=1234
ptpln	Название шаблона рекламной паузы. Речь идет о значении в поле "Название" в аккаунте Менеджера рекламы, а не об отображаемом названии.	ptpln=my_break_template
an	Параметр an представляет собой название приложения. Его следует добавлять к запросам, отправляемым из мобильных приложений или с подключенных телевизоров. Этот параметр необходим почти для всех видеообъявлений с алгоритмической продажей*. IMA SDK автоматически присваивает значение этому параметру, но при работе с API динамической вставки объявлений (в средах без использования SDK) значение должны указывать вы. * Название приложения должно быть человекочитаемым. При показе на устройствах с iOS и tvOS пакет SDK не может получить доступ к 9-значному идентификатору приложения в App Store. Тогда SDK отправляет Bundle ID через параметр an (в формате com.пакет.издатель).	an=sample%20app
ltd	Показывать ли рекламу с ограниченным таргетингом, если не получено согласие на использование файлов cookie и других идентификаторов. Подробнее…	ltd=1
rdid idtype is_lat	В нативных приложениях (работающих не в мобильных и обычных браузерах) SDK передает сбрасываемые идентификаторы устройств для таргетинга в запросы вашего потока с параметрами rdid, idtype и is_lat. Для потоков с добавлением маяков на сервере эти параметры нужно передавать явным образом, как и в запросах объявлений Решений для видеорекламы на стороне клиента. В iOS 14.5 и более поздних версий больше не поддерживается сигнал LAT. Вместо этого сигнала Google полагается на наличие идентификатора IDFA с ненулевым значением, указывающего на то, что пользователь дал согласие на отслеживание на тех версиях iOS, которые совместимы с фреймворком App Tracking Transparency. Поэтому вам потребуется действительное свойство UserAgent, указывающее подходящую версию ОС.	Ознакомьтесь с примерами сбрасываемых идентификаторов устройств.
trt	Этот параметр позволяет обозначить тип трафика (оплаченный, обычный или неустановленный).	Неустановленный тип трафика: trt=0 Оплаченный трафик: trt=1 Бесплатный трафик: trt=2
vconp	Рекомендуется руководством MRC по работе с данными о видеорекламе Указывает, используется ли в проигрывателе непрерывное воспроизведение контента, как при телевещании. Допустимые значения: 2 (непрерывное воспроизведение используется) и 1 (непрерывное воспроизведение не используется). Если значение этого параметра неизвестно, задавать его не нужно.	Непрерывное воспроизведение используется: vconp=2   Непрерывное воспроизведение не используется: vconp=1
vpa	Рекомендуется руководством MRC по работе с данными о видеорекламе Указывает, начинается ли воспроизведение объявления автоматически или по клику. Допустимые значения: click (если требуется действие пользователя) и auto (если видео воспроизводится автоматически). Если значение этого параметра неизвестно, задавать его не нужно.	Автоматическое: vpa=auto   По клику: vpa=click
vpmute	Рекомендуется руководством MRC по работе с данными о видеорекламе Указывает, начинается ли воспроизведение объявления, если в видеопроигрывателе отключен звук. Допустимые значения: 1 (если звук отключен) и 0 (если звук включен). Если значение этого параметра неизвестно, задавать его не нужно.	Звук отключен: vpmute=1   Звук включен: vpmute=0
npa	Настройка персонализации для запросов объявлений. Рекомендуем указывать этот параметр в начале тега, чтобы он считался даже в случае неполной загрузки файла. Чтобы запросить неперсонализированные объявления, укажите npa=1. Если параметр не указан, будут возвращаться персонализированные объявления.	npa=1
omid_p	Параметр "Название партнера, использующего OMID API" принимает переменное значение, которое включает название организации-партнера, применяющей OMID для отслеживания, и версию ее системы. Этот параметр доступен только издателям, которые хотят при работе с Open Measurement SDK (OM SDK) использовать отслеживание Active View, и не подходит для случаев, в которых используется IMA SDK с автоматически заданными настройками. Чтобы при использовании библиотеки Programmatic Access Library (PAL) сообщить о поддержке OMID, необходимо указать название организации-партнера (omidPartnerName) и версию ее системы (omidPartnerVersion). Если вы не используете библиотеку PAL или IMA, вам необходимо задать параметры omid_p и sdk_apis. Они позволяют передавать информацию о поддерживаемых API, среди которых могут быть указаны другие API, перечисленные через запятую.	Код при использовании PAL: request.omidPartnerName = 'examplepartnername' request.omidPartnerVersion = '1.0.0.0' Код в случае, если вы не используете PAL: omid_p=examplepartnername/1.0.0.0&sdk_apis=7
gdpr gdpr_consent	Эти поля передают данные о том, что пользователь предоставил согласие в соответствии со спецификацией TCF версии 2.0, как во входящих, так и в исходящих запросах на синхронизацию файлов cookie.	Ознакомьтесь со спецификациями GDPR.
givn|paln	Если вы работаете с библиотекой PAL, то параметр с однократно используемым числом для видеообъявления может принимать переменное строковое значение. Однократно используемое число не требует кодирования при добавлении в URL. Примечание. Если ранее вы добавляли однократно используемое число, используя устаревший параметр paln, то мы рекомендуем отказаться от него и перейти на параметр givn. Также не следует добавлять оба этих параметра.	Более подробную информацию о том, какое значение передается при использовании этого параметра, можно найти в руководстве по началу работы с библиотекой PAL.
addtl_consent	Список разрешенных поставщиков рекламных технологий Google, не зарегистрированных в IAB.	Ознакомьтесь со спецификациями дополнительного согласия.
rdp	При этом должен быть задан вариант rdp=1 или просто rdp (без значения). Если в запросе этот параметр не указан или задан как rdp=0, пользовательские данные будут обрабатываться без ограничений (за исключением случаев, когда такое ограничение задано в настройках сети).	rdp=1
sdk_apis	В качестве значения для фреймворка API SDK может использоваться разделенный запятыми список постоянных целых значений, указывающих на то, какие фреймворки API поддерживает проигрыватель. На сайте GitHub приведен список возможных значений, относящихся к фреймворкам API. Этот параметр используется издателями, которые работают с библиотекой PAL. Если вы используете IMA SDK и попытаетесь указать значения для этого параметра, то они будут переопределены на варианты, поддерживаемые в IMA SDK.	sdk_apis=2,7,9
sid	Тип рекламного идентификатора с защитой конфиденциальных данных, который можно использовать только для ограничения частоты показов. Согласно специальным требованиям организации IAB значение этого параметра должно быть в формате UUID. Подробнее… Чтобы отключить передачу идентификатора сеанса, присвойте параметру sid нулевое значение.	sid=123e4567-e89b-12d3 -a456-426614174000
wta	Указывает, может ли проигрыватель показывать сообщение Почему я вижу эту рекламу?. Если вы используете IMA SDK, поддержка этого значения обеспечивается автоматически. Если вы не используете IMA SDK, то в проигрывателе должна быть реализована поддержка Icon и IconClickFallbackImage для VAST в соответствии с требованиями API динамической вставки объявлений*. Параметр wta не поддерживается при использовании маяков на сервере (SSB). Это поле является обязательным, если вы используете Ad Exchange. Подробнее… *Поддержка IconClickFallbackImage не требуется (за исключением подключенных телевизоров).	Поддерживается: wta=1 Не поддерживается: wta=0

Переопределение тега объявления по умолчанию с помощью IMA SDK

Запрашивая поток с динамической вставкой объявлений через IMA SDK, проигрыватель может передать нужные данные в поле adTagParameters. Обычно оно состоит из пар "ключ – значение", где ключи могут быть параметрами тега объявления Менеджера рекламы. Эти параметры перечислены в таблице выше.

Используя подобный набор ключей и значений, вы можете настраивать поток и передавать параметры, которые не связаны с запросом объявления Менеджера рекламы. Подробнее о том, как запросить определенные варианты потоков и как настроить период без рекламы…

В зависимости от платформы и языка программирования реализация поля adTagParameters может немного варьироваться. Подробные сведения представлены в документации для разработчиков iOS, Android, tvOS, Chromecast или HTML5, а также в руководстве по реализации динамической вставки объявлений.

 

Как задавать значения для adTagParameters с помощью SDK

Задавая с помощью SDK значения параметров cust_params или description_url для iOS, tvOS и Android, не кодируйте символы. Параметр cust_params может представлять собой одну строку из пар "ключ –значение", разделенных символом &.

Предположим, вы хотите присвоить параметру cust_params значение sport=football&city=newyork.

Тогда структура поля adTagParams без кодирования будет выглядеть так:

{
"tfcd": 1,
"iu": "/987654321/path/to/adunit",
"cust_params": "sport=football&city=newyork",
"description_url": "http://www.sample.com/golf.html",
"ppid": "12JD92JD8078S8J29SDOAKC0EF230337"
}
 

А структура поля adTagParameters с кодированием для запросов потока HTML5 будет выглядеть так:

{
"tfcd": 1,
"iu": "/987654321/path/to/adunit",
"cust_params": "sport%3Dfootball%26city%3Dnewyork",
"description_url": "http%3A%2F%2Fwww.sample.com%2Fgolf.html",
"ppid": "12JD92JD8078S8J29SDOAKC0EF230337"
}
 

Структура поля adTagParams с кодированием для запросов потока Roku будет выглядеть так:

request.adTagParams="tfcd=1&iu=/987654321/path/to/adunit&cust_params=sport%3Dfootball%26city%3Dnewyork&description_url=http%3A%2F%2Fwww.sample.com%2Fgolf.html&ppid=12JD92JD8078S8J29SDOAKC0EF230337"

Переопределение тега объявления по умолчанию с помощью DAI API ^(бета) 

Запрашивая поток с динамической вставкой объявлений через DAI API, проигрыватель при необходимости может передать определенные пары "ключ – значение". Ключи в них могут быть параметрами тега объявления Менеджера рекламы из тех, которые перечислены в таблице выше.

Эти параметры должны отправляться в теле HTTP-запроса POST с типом формы application/x‑www‑form‑urlencoded. Сказанное относится и к прямым трансляциям, и к видео по запросу.

Используя подобный набор ключей и значений, вы можете настраивать поток и передавать параметры, которые не связаны с запросом объявления Менеджера рекламы. Узнайте, как переопределить параметры вариантов трансляции и как выполнить аутентификацию при помощи кода HMAC.

Ознакомьтесь с примером использования DAI API.

Переопределение тега объявления по умолчанию в случае, если применяются маяки на сервере (SSB)

Ниже приведены примеры того, как изменять тег объявления по умолчанию для видео при использовании маяков на сервере. В примерах выделены переопределенные параметры, передаваемые проигрывателем или приложением.

Примеры для видео по запросу

	Пример
Исходный URL видеопотока	http://dai.google.com/ondemand/hls/content/ <contentid>/vid/<vid>/master.m3u8
С указанием рекламного блока	http://dai.google.com/ondemand/hls/content/ <contentid>/vid/<vid>/master.m3u8?iu=/9876/ path/to/adunit
C переопределенными парами "ключ-значение"	http://dai.google.com/ondemand/hls/content/ <contentid>/vid/<vid>/master.m3u8& cust_params=sport%3Dgolf%26section%3Dblog %26anotherKey%3Dvalue1%2Cvalue2
С пометкой контента для детей	http://dai.google.com/ondemand/hls/content/ <contentid>/vid/<vid>/master.m3u8?tfcd=1
C переопределенным рекламным блоком И парами "ключ-значение" И специальным параметром description_url И пометкой контента для детей	http://dai.google.com/ondemand/hls/content/ <contentid>/vid/<vid>/master.m3u8& iu=/9876/path/to/adunit& cust_params=sport%3Dgolf%26section %3Dblog%26anotherKey%3Dvalue1%2Cvalue2& description_url=https://mysite.com/description.html& tfcd=1

 

Примеры для потокового видео с линейными объявлениями

	Пример
Исходный URL прямой трансляции с линейными объявлениями	https://dai.google.com/linear/hls/event/<asset_key> /master.m3u8
С указанием рекламного блока	https://dai.google.com/linear/hls/event/<asset_key> /master.m3u8?iu=/9876/path/to/adunit
С переопределенными парами "ключ-значение"	https://dai.google.com/linear/hls/event/<asset_key> /master.m3u8?cust_params=sport%3Dgolf%26section %3Dblog%26otherKey%3Dvalue1%2Cvalue2
С пометкой контента для детей	https://dai.google.com/linear/hls/event/<asset_key> /master.m3u8?tfcd=1
С переопределенным рекламным блоком И парами "ключ-значение" И специальным параметром description_url И пометкой контента для детей	https://dai.google.com/linear/hls/event/<asset_key> /master.m3u8& iu=/9876/path/to/adunit& cust_params=sport%3Dgolf%26section%3Dblog%26otherKey %3Dvalue1%2Cvalue2& description_url=https://mysite.com/description.html& tfcd=1

Динамическое обновление параметров таргетинга во время определенной прямой трансляции

Данные таргетинга для определенного пользователя, который смотрит прямую трансляцию, можно динамически обновлять с помощью метода replaceAdTagParameters в IMA DAI SDK.

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