Инструкция по внедрению рекламы в видео плеер

1. Общие положения

Данная инструкция описывает в полном объеме все особенности внедрения рекламы в видео-плееры для сайтов.

Техническое обеспечение показа рекламы обеспечивается технологиями ADFOX.

Для внедрения рекламы используются международные стандарты IAB (Interactive Advertising Bureau), в т.ч. стандарты VAST 2.0 и VPAID 1.1. В данном документе описываются конечные решения в рамках данных стандартов.
Полная документация (на английском языке) находится на сайте IAB:
http://www.iab.net/media/file/VAST-2_0-FINAL.pdf
http://www.iab.net/media/file/VPAIDFINAL51109.pdf.


2. Общая схема взаимодействия видео-плеера и ADFOX


3. Реализация взаимодействия видео плеера и системы ADFOX

3.1 Запрос рекламы к серверу ADFOX плеером

Для получения рекламы плеером необходимо сделать запрос к серверу ADFOX.

Запрос для каждого типа рекламы, как то Pre-roll, post-roll, mid-roll, overlay и pause-roll – разные, плеер должен определить какую рекламу ему требуется показать в данный момент и выбрать один из запросов.

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


3.2 Получение ответа от сервера ADFOX

3.2.1 Рекламы для показа нет

Когда нет подходящей рекламы для показа, ADFOX возвращает следующий XML:

<?xml version=”1.0”?><nobanner></nobanner>

При получении данного ответа необходимо начать/продолжить показ плеером основного контента.

Во всех других случаях ADFOX возвращает XML в стандарте VAST 2.0.


3.2.2 Стандартный ответ VAST 2.0 с содержимым Linear Ad

Пример XML ответа для Linear Ad вы можете найти по следующей ссылке

https://ads.adfox.ru/168627/getCode?p1=bdcfe&p2=ekza&pfc=zymd&pfb=dkvcj&plp=a&pli=a&pop=a&puid1=

Далее идёт детальное описание того, какие элементы пришедшего XML вам понадобятся и для чего.

Получение рекламы (визуализация)

Ссылка на креатив содержится в элементе MediaFile блока MediaFiles. Тип медиа-файла указывается в атрибуте type элемента MediaFile.

<MediaFiles>
<MediaFile id="1" delivery="progressive" type="video/x-flv" bitrate="" maintainAspectRatio="true" scalable="true" width="640" height="360">
http://content2.adfox.ru/130618/adfox/205544/801069_1.flv?rnd=1527757745 </MediaFile>
</MediaFiles>

В таблице перечислены возможные значения атрибута type для разных типов креатива

НазваниеMIME-тип
FLVvideo/x-flv
MP4video/mp4
WEBMvideo/webm
MOVvideo/quicktime
SWFapplication/x-shockwave-flash
JPGimage/jpeg
PNGimage/png
GIFimage/gif

В блоке MediaFiles может находиться несколько элементов MediaFile с разными параметрами: тип файла, размер, битрейт, id. В этом случае плеер должен по возможности определить наиболее подходящий для устройства, типа плеера, ширины канала элемент и ссылку на креатив.

Подсчёт перехода

Ссылка для перехода содержится в элементе ClickThrough блока VideoClicks.

<ClickThrough>
http://ads.adfox.ru/168627/goLink?p2=ekza&p1=bdcfe&p5=btpaj&pr=btkqqqb@http://adfox.ru
</ClickThrough>

Подсчёт событий

Также пришедший XML содержит ссылки которые нужно использовать для подсчёта событий, эти ссылки необходимо запросить в момент наступления того или иного события в плеере.

Первое событие, которое необходимо учитывать, содержится в блоке

<Impression> 

его нужно вызывать в момент готовности креатива к проигрыванию.

Пример:

<Impression>http://ads.adfox.ru/168627/event?p2=ekza&p1=bdcfe&p5=btpaj&pr=btkqqqb&pm=d</Impression>

Ссылки на остальные события нужно брать из блока TrackingEvents. Они находятся в элементах Tracking. Обязательный атрибут event элемента Tracking соответствует типу события, которое подсчитывает данная ссылка.

<Tracking event="close">
http://ads.adfox.ru/168627/event?p2=ekza&p1=bdcfe&p5=btpaj&pr=btkqqqb&pm=r
</Tracking>

Далее приведём стандартный список событий, которые необходимо подсчитывать, Заметим, что этот список НЕ исчерпывает все элементы Tracking, которые будут присутствовать в XML ответе сервера ADFOX, тем не менее, необходимым минимум являются перечисленные ниже события:

НазваниеСобытие
Ролик выбранcreativeView
Начало просмотраstart
Первая четверть просмотраfirstQuartile
Середина просмотраmidpoint
Третья четверть просмотраthirdQuartile
Окончание просмотраcomplete
Клик на крестик закрытияclose
Выключить звукMute (слайдер управления громкостью рекламных роликов по умолчанию выставляется на 40%)
Включить звукUnmute (слайдер управления громкостью рекламных роликов по умолчанию выставляется на 40%)
Постановка рекламного ролика на паузуPause
Продолжение просмотра рекламного роликаResume

Ролик выбран – XML может содержать несколько креативов для различных платформ. Событие вызывается при выборе файла для проигрывания.
Событие creativeView запрашивается один раз и НЕ должно запрашиваться каждую секунду.
Начало просмотра – первая секунда показа креатива
События impression, creativeView и start вызываются практически одновременно на первом кадре ролика в описанной последовательности.
Первая четверть просмотра – завершение показа четверти ролика, или четверти времени, указанного для показа оверлея в атрибуте minSuggestedDuration тега NonLinear.
Середина просмотра – завершение показа половины ролика, или половины времени, указанного для показа оверлея в атрибуте minSuggestedDuration тега NonLinear.
Третья четверть просмотра - завершение показа трёх четвертей ролика, или трёх четвертей времени, указанного для показа оверлея в атрибуте minSuggestedDuration тега NonLinear.
Окончание просмотра – ролик просмотрен до конца. Оверлей был виден всё время, указанное в атрибуте minSuggestedDuration тега NonLinear.
Событие complete вызывается при полном просмотре ролика и не вызывается при переходе или закрытии (close).
Клик на крестик закрытия – пользователь кликнул на крестик закрытия.
Выключить звук – пользователь отключил звук.
Включить звук – пользователь включил звук.
Постановка рекламного ролика на паузу – пользователь поставил на паузу рекламный ролик (самостоятельно или в соответствии с механикой работы видеоплеера).
Продолжение просмотра рекламного ролика – пользователь возобновил просмотр рекламного ролика (самостоятельно или в соответствии с механикой работы видеоплеера).

Также есть два события, которые необходимо учитывать, которые не содержится в описанном блоке. Это события "Клик по плашке «пропустить рекламу»" и "Клик по плашке «перейти на сайт рекламодателя»".
Ссылка на данные событие содержится в блоке Extensions в элементе

<Extension type="skipAd">
http://ads.adfox.ru/168627/event?p2=ekza&p1=bdcfe&p5=btpaj&pr=btkqqqb&pm=s
</Extension> 
<Extension type="addClick">
http://ads.adfox.ru/168627/event?p2=ekza&p1=bdcfe&p5=btpaj&pr=btkqqqb&pm=t
</Extension>

Клик по плашке «пропустить рекламу» - пользователь нажал на плашку «пропустить рекламу». Не путать с событием close.
Клик по плашке «перейти на сайт рекламодателя» - пользователь нажал на плашку «перейти на сайт рекламодателя». При нажатии вызывается событие, затем пользователь отправляется по ссылке из элемента ClickThrough блока VideoClicks.

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

Использование дополнительных параметров из блока Extensions

В блоке Extensions содержатся дополнительные параметры для настройки рекламы, а также параметры плашки, которые должен учитывать ваш видео-плеер. Они приведены в следующей таблице.

НазваниеОписание
skipTimeВремя показа плашки «Пропустить рекламу»
skipTime2Время показа крестика закрытия
linkTxtТекст на плашке перехода
isClickableФлаг кликабельности баннера
skipAdКлик по плашке «пропустить рекламу»
<Extensions>
<Extension type="skipTime">05:00</Extension>
<Extension type="skipTime2">00:05</Extension>
<Extension type="linkTxt">перейти на сайт рекламодателя</Extension>
<Extension type="isClickable">1</Extension>
<Extension type="skipAd">
http://ads.adfox.ru/168627/event?p2=ekza&p1=bdcfe&p5=btpaj&pr=eypeyrh&pm=s
</Extension> 
<Extension type="addClick">
http://ads.adfox.ru/168627/event?p2=ekza&p1=bdcfe&p5=btpaj&pr=eypeyrh&pm=t
</Extension>
</Extensions>

Название параметров содержится в атрибуте type элемента Extension.

Теперь подробнее:

Ваш видео плеер должен уметь создавать три элемента:
• плашку для перехода на сайт рекламодателя
• плашку для пропуска рекламы
• крестик закрытия рекламы

Важно, чтобы соответствующие элементы управления рекламой появлялись в нужное время, указанное в блоке Extensions. Разберём пример, приведённый выше. В нём время показа плашки пропуска рекламы указано как 5 минут, это значит, что плашка должна быть показана через 5 минут, после начала показа рекламного креатива. Очевидно, что вы нигде не найдёте такого длинного рекламного креатива – в таком случае, когда время показа плашки превышает время показа самого рекламного ролика, плашку показывать не надо.

В остальных случаях её надо показать в указанный момент времени.

Параметр linkTxt содержит текст, который необходимо вставить на плашку перехода на сайт рекламодателя. Ещё один важный параметр, на котором стоит остановиться подробнее это параметра isClickable. Не все рекламные ролики должны быть кликабельными.

В случае, если значение параметра равно 0, то переход по рекламе осуществлять не надо, также, не надо показывать плашку «Перейти на сайт рекламодателя»

isClickableДействие
0Переход не осуществлять
1Осуществлять переход, ссылка для перехода содержится в элементе ClickThrough блока VideoClicks

События не обязательные для вызова

Дополнительно разберем события, которые приходят в xml, но не обязательны для обработки, если механика отсутствует в видео плеере:

НазваниеСобытие
Просмотр сначала rewind
Переход в полный экранfullscreen
Развернуть expand
Свернутьcollapse
Перейти к следующему ролику acceptInvitation

Просмотр сначала – возобновление просмотра того же ролика с начала по желанию пользователя.
Переход в полный экран – перевод плеера в полноэкранный режим просмотра во время просмотра рекламного ролик.
Развернуть – пользователь активировал увеличение плеера на странице.
Свернуть – пользователь активировал уменьшение плеера на странице.
Перейти к следующему ролику – инициализация дополнительной части креатива.


3.2.3 Стандартный ответ VAST 2.0 c содержимым Non-linear Ad

В основном отличия от Linear Ad заключаются лишь в названии элементов, откуда нужно получить ссылку на креатив и ссылку перехода, тем не менее, рекомендуем внимательно свериться с этим описанием.

Пример XML ответа для Non-Linear Ad вы можете найти по следующей ссылке

https://ads.adfox.ru/168627/getCode?p1=bighc&p2=eoji&pfc=zymd&pfb=csibz&plp=a&pli=a&pop=a&puid1=

Получение рекламы (визуализация)

Ссылка на креатив содержится в элементе StaticResource блока NonLinear. Тип медиа-файла указывается в атрибуте creativeType элемента StaticResource .

<NonLinear  id="overlay" width=”520" height="100" minSuggestedDuration="00:00:10”>                          
    <StaticResource  creativeType=" image/png">

    </StaticResource>
    <NonLinearClickThrough>

    </NonLinearClickThrough>
</NonLinear>

Также необходимо использовать атрибуты элемента NonLinear

width – параметр, определяющий ширина креатива.
height – параметр, определяющий высота креатива.
minSuggestedDuration – параметр, определяющий продолжительность показа креатива в формате чч:мм:сс.

В таблице перечислены возможные значения атрибута type для разных типов креатива

НазваниеMIME-тип
SWFapplication/x-shockwave-flash
JPGimage/jpeg
PNGimage/png
GIFimage/gif

Подсчёт перехода

Ссылка для перехода содержится в элементе NonLinearClickThrough блока NonLinear.

<NonLinearClickThrough>
http://ads.adfox.ru/168627/goLink?p2=eoji&p1=bighc&p5=btozn&pr=gitmfid
</NonLinearClickThrough>

Подсчёт событий

Также пришедший XML содержит ссылки, которые нужно использовать для подсчёта событий, эти ссылки необходимо запросить в момент наступления того или иного события в плеере. Первое событие, которое необходимо учитывать, содержится в блоке

<Impression>

его нужно вызывать в момент готовности креатива к проигрыванию.

<Impression>http://ads.adfox.ru/168627/event?p2=eoji&p1=bighc&p5=btozn&pr=gitmfid&pm=d</Impression>

Ссылки на остальные события нужно брать из блока TrackingEvents. Они находятся в элементах Tracking. Обязательный атрибут event элемента Tracking соответствует типу события, которое подсчитывает данная ссылка.

<Tracking event="close">
http://ads.adfox.ru/168627/event?p2=eoji&p1=bighc&p5=btozn&pr=gitmfid&pm=r
</Tracking>

Далее приведём стандартный список событий, которые необходимо подсчитывать, Заметим, что этот список НЕ исчерпывает все элементы Tracking, которые будут присутствовать в XML ответе сервера ADFOX, тем не менее, необходимым минимум являются перечисленные ниже события:

НазваниеСобытие
Ролик выбранcreativeView
Начало просмотраstart
Первая четверть просмотраfirstQuartile
Середина просмотраmidpoint
Третья четверть просмотраthirdQuartile
Окончание просмотраcomplete
Клик на крестик закрытияclose
Выключить звукMute (слайдер управления громкостью рекламных роликов по умолчанию выставляется на 40%)
Включить звукUnmute (слайдер управления громкостью рекламных роликов по умолчанию выставляется на 40%)

Ролик выбран – XML может содержать несколько креативов для различных платформ. Событие вызывается при выборе файла для проигрывания.
Событие creativeView запрашивается один раз и НЕ должно запрашиваться каждую секунду.
Начало просмотра – первая секунда показа креатива.
События impression, creativeView и start вызываются практически одновременно на первом кадре ролика в описанной последовательности.
Первая четверть просмотра – завершение показа четверти ролика, или четверти времени, указанного для показа оверлея в атрибуте minSuggestedDuration тега NonLinear.
Середина просмотра – завершение показа половины ролика, или половины времени, указанного для показа оверлея в атрибуте minSuggestedDuration тега NonLinear.
Третья четверть просмотра - завершение показа трёх четвертей ролика, или трёх четвертей времени, указанного для показа оверлея в атрибуте minSuggestedDuration тега NonLinear.
Окончание просмотра – ролик просмотрен до конца. Оверлей был виден всё время, указанное в атрибуте minSuggestedDuration тега NonLinear.
Событие complete вызывается при полном просмотре ролика и не вызывается при переходе или закрытии (close).
Клик на крестик закрытия – пользователь кликнул на крестик закрытия.

Также есть событие, которые необходимо учитывать, которые не содержится в описанном блоке. Это событие "Клик по плашке «перейти на сайт рекламодателя»". Ссылка на событие содержится в блоке Extensions в элементе

<Extension type="addClick">
http://ads.adfox.ru/168627/event?p2=eoji&p1=bighc&p5=btozn&pr=gitmfid&pm=t
</Extension>

Клик по плашке «перейти на сайт рекламодателя» - пользователь нажал на плашку «перейти на сайт рекламодателя». При нажатии вызывается событие, затем пользователь отправляется по ссылке из элемента NonLinearClickThrough блока NonLinear.

Использование дополнительных параметров из блока Extensions

В блоке Extensions содержатся дополнительные параметры для настройки рекламы, а также параметры плашки, которые должен учитывать ваш видео-плеер. Они приведены в следующей таблице.

НазваниеОписание
skipTime2Время показа крестика закрытия
linkTxtТекст на плашке перехода
isClickableФлаг кликабельности баннера
<Extensions>
<Extension type="skipTime2">00:05</Extension>
<Extension type="linkTxt">перейти на сайт     рекламодателя</Extension>
<Extension type="isClickable">1</Extension>
<Extension type="addClick">
http://ads.adfox.ru/168627/event?p2=eoji&p1=bighc&p5=btozn&pr=gitmfid&pm=t</Extension>
</Extensions>

Название параметров содержится в атрибуте type элемента Extension.

Ваш видео плеер должен уметь создавать три элемента:
• плашку для перехода на сайт рекламодателя.
• крестик закрытия рекламы.

Важно, чтобы соответствующие элементы управления рекламой появлялись в нужное время, указанное в блоке Extensions.

Параметр linkTxt содержит текст, который необходимо вставить на плашку перехода на сайт рекламодателя.
Ещё один важный параметр, на котором стоит остановиться подробнее это параметра isClickable. Не все рекламные ролики должны быть кликабельными.

В случае, если значение параметра равно 0, то переход по рекламе осуществлять не надо, также, не надо показывать плашку «Перейти на сайт рекламодателя»

isClickableДействие
0Переход не осуществлять
1Осуществлять переход, ссылка для перехода содержится в элементе ClickThrough блока VideoClicks

3.2.4 Стандартный ответ VAST 2.0 с содержимым WrapperAd

Краткое введение в понятие Wrapper Ad

При запросе XML для показа видео-рекламы от ADFOX, помимо «стандартных» кодов VAST 2.0, с которыми вы уже умеете работать, вам могут приходить так называемые Wrapper-коды, предназначенные для продергивания рекламы сторонних систем.

Пример wrapper кода ADFOX можно посмотреть по ссылке

http://ads.adfox.ru/168662/getCode?pp=i&ps=bfcd&p2=epaj&pfc=a&pfb=a&plp=a&pli=a&pop=a

Также приводим более короткий пример Wrapper-кода (Telemetry)

<VAST version="2.0">
    <Ad id="602833">
        <Wrapper>
            <AdSystem>Telemetry</AdSystem>
            <VASTAdTagURI>
                http://spc.cemgleffdekhogdhlgggledh.vast2as3.GPMD-pubnet.Russia.telemetryverification.net/?cb=[timestamp];subtagid=100;subtagname=;referrer=
            </VASTAdTagURI>
            <Impression>
                http://ads.adfox.ru/6956/event?p2=ekbx&p1=begem&p5=baiiq&pr=eeacsni&pm=d
            </Impression>
            <Creatives></Creatives>
        </Wrapper>
    </Ad>
</VAST>

Главное отличие от уже знакомого вам VAST-кода, это наличие элемента Wrapper, а в нем – элемента VASTAdTagURI. Внутри последнего содержится ссылка на получение XML-кода сторонней рекламной системы.

Это означает, что необходимо сделать ещё один запрос для получения рекламы уже от стороннего сервера, воспользовавшись ссылкой, полученной из элемента VASTAdTagURI.

Помимо этого, Wrapper-код будет содержать ссылки на стандартные события (уже описанные подробно в предыдущих секциях этого документа).

Также, код Wrapper-а будет содержать блок Extensions (уже описанные подробно в предыдущих секциях этого документа) «стандартном» VAST-коде.

        

Подсчёт перехода

Во Wrapper коде присутствует блок

<VideoClicks>

содержащий

<ClickTracking>

данное событие необходимо запрашивать при наступлении клика в пришедшем xml второго запроса. Пользователь отправляется по ссылке из элемента ClickThrough блока VideoClicks из xml второго запроса.

Описание работы с Wrapper Ad

Чтобы понять, что вместо стандартной рекламы вы получили Wrapper рекламу необходимо проверить XML ответ на наличие элемента Wrapper, и, если содержит, запросить содержимое по ссылке в VASTAdTagURI. В ответ придет новый VAST-совместимый XML. 

При повторном запросе вы можете получить один из трёх ответов:
• VAST 2.0 linear или non-linear Ad
• VAST 2.0 VPAID container
• VAST 2.0 Wrapper Ad

Подробнее о VPAID- контейнерах вы можете узнать из следующего раздела. Теперь давайте подробнее остановимся на самом wrapper’e. 

События первого запроса

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

Исключение составляет

<Extension type="controls">

Extension type="controls" отвечает за показ элементов управления плеера, где 1 – показывать, а 0 – скрыть, при этом нужно проверять значения двух других элементов: skipTime и skipTime2.
При наличии этих элементов показывается в соответствии со временем указанным в них.
Если Extension type="skipTime" отсутствует, то не показывать элемент управления «пропустить рекламу», если Extension type="skipTime2" отсутствует, то не показывать элемент управления «крестик».
В случае, если приходит скрыть контролы, но при этом есть какой-либо из skipTime, то приоритет отдаем Extension type="controls".

Extension type="addClick",  в случае wrapper, используется для подсчёта перехода по плашке перейти на сайт рекламодателя в случае присутствия её в пришедшем xml второго запроса. 

События второго запроса

При этом во вновь запрошенном файле, указанном  в элементе wrapper’а VASTAdTagURI, может содержаться такой же блок показа, перехода, событий и экстеншионов. Пришедшие во втором запросе события и т.д., тоже необходимо учитывать. Учитывать необходимо оба набора событий и extensions во wrapper и в пришедшем в нем блоке в соответствии с наступившем событием.

Стандарт VAST 2.0 не запрещает, чтобы в файле Wrapper содержалась ссылка на ещё один Wrapper , таким образом, после получения второго wrapper’a необходимо будет сделать ещё один запрос и получить ещё один набор событий и параметров для учёта. Описанная ситуация маловероятна, но возможна.


3.2.5 Стандартный ответ VAST 2.0 с содержимым VPAID container и особенности демонстрации формата

VPAID – это международный стандарт flash-контейнера, умеющего проигрывать видео-рекламу, со стандартизированным интерфейсом управления и стандартизированными событиями.

Если в полученном вами XML, в элементе MediaFile есть атрибут apiFramework, и он равен «VPAID» – перед вами VPAID-совместимый контейнер.
Значение "0", так же логично считать значением атрибута указывающим на то что медиафайл не требует специального метода общения.

Пример XML c VPAID container

http://banners.adfox.ru/161020/adfox/525740/primer.xml

Пример VPAID-совместимого контейнера (код Telemetry)

<MediaFiles>
<MediaFile delivery="progressive" height="0" width="0" type="application/x-shockwave-flash"  apiFramework="VPAID">
http://cdn3.telemetryverification.net/tv2n/telemetry_player_vpaid_as3/live/r0020/telemetry_player_vpaid_as3.swf?sid=1286208871201048415&itm=2&cdns=http://cdn454.telemetryverification.net,0.5,http://ff1.telemetryverification.net,0.5&heatmap=0.1&wintop=1.0&windepth=1.0&psbaseurl=http://GPMD-pubnet.Russia.telemetryverification.net&hold=2&spaceid=BlKUCznskfKs&bid=BPKoC(HoSUm8&cid=BhSmKA8WSHWQ&adid=BhSmKA8WSHWQ&cpath=/content/rb/clearasil_onw_overnight_wash15_ru_linear_as3/r0001/clearasil_onw_overnight_wash15_ru_linear_450x360_as3.swf&allowimpactevt=1&ctu=http%3A%2F%2Fwww.clearasil.ru&3rdpurl=Ihttp%3A%2F%2FGPMD-pubnet.telemetryaudit.com%2Fts%2Fpse1rndx5f1x5fx5ftimx5f1x5fx5ftv2nspidx5fcemgleffdekhogdhlgggledh%2Fpse1%2Fblank.gif%3Frnd%3D%5Btimestamp%5D&enableinplayercontrols=1&querystring=cb%3d[timestamp]%3bsubtagid%3d100%3bsubtagname%3d%3breferrer%3d
</MediaFile>
</MediaFiles>

Для работы с VPAID-контейнером нужно сделать следующее:

1. Загрузить SWF-файл из тега MediaFile
2. Добавить SWF-файл на главную сцену вашего проигрывателя
3. Вызвать метод handshakeVersion()
4. Вызвать метод initAd();
5. Дождаться события AdLoaded
6. Вызвать метод startAd()

Далее, можно контролировать воспроизведение видео при помощи стандартных методов, описанных в спецификации VPAID, и обрабатывать события, также описанные в спецификации. Ниже приведен список основных доступных методов и событий.

Свойства:

get adRemainingTime():Number - оставшееся время показа рекламы
get adVolume():Number - получить уровень громкости в данный момент
set adVolume(value:Number):void - задать уровень громкости

Методы(функции):

handshakeVersion(playerVPAIDVersion:String):String - проверка состыковки версий плеера Рекламы и используемой версии описания

initAd(width:Number, height:Number, viewMode:String, desiredBitrate:Number, creativeData:String, environmentVars:String):void - инициализация рекламного плеера:
width, height - размеры рекламного плеера
viewMode - фулскрин либо нормальный режим просмотра
desiredBitrate - битрейт видео
creativeData – данные из блока adParameters (передаются строкой)
environmentVars - можно оставить пустым

resizeAd(width:Number, height:Number, viewMode:String):void - изменение размеров и положения рекламного видео
width,height - размеры рекламного плеера
viewMode - фулскрин либо нормальный режим просмотра

startAd():void - запуск рекламы

stopAd():void - остановка рекламы

pauseAd():void - пауза рекламы

resumeAd():void - возобновление воспроизведения рекламы

События контейнера:

"AdLoaded" - рекламный плеер загрузился

"AdStarted" - начат просмотр рекламы

"AdStopped" - закончен просмотр рекламы

"AdRemainingTimeChange" - изменилось оставшееся время

"AdVolumeChange" - изменился уровень звука

"AdImpression" - начало реального просмотра рекламы

"AdVideoStart" - старт рекламного видео

"AdVideoFirstQuartile" - просмотрена первая четверть видео

"AdVideoMidpoint" - просмотрена вторая четверть видео

"AdVideoThirdQuartile" - просмотрена третья четверть видео

"AdVideoComplete" - видео просмотрено полностью

"AdClickThru" - был осуществлён переход по рекламе

"AdUserClose" - реклама закрыта пользователем

"AdPaused" - реклама поставлена на паузу

"AdPlaying" – возобновление воспроизведения рекламы

"AdLog" - событие для дебаггера

"AdError" - ошибка плеера

Учет событий в VPAID-контейнере

Если ранее, в коде Wrapper-a, вам пришел блок TrackingEvents, это значит, что необходимо в ответ на события в VPAID-контейнере запрашивать соответствующую ссылку из этого блока. Например, при наступлении событии AdVideoFirstQuartile необходимо запросить ссылку из тега Tracking event="firstQuartile".

Абсолютно обязательным является вызов ссылки из элемента Impression при наступлении события AdImpression. И вызов ссылок событий creativeView и start из блока TrackingEvents. В противном случае показы рекламы не будут засчитаны! Блоков Impression в пришедшем xml может быть несколько, обязателен вызов ссылок из всех блоков. Обязательным является вызов ссылки из элемента Error при наступлении события AdError

Ниже приведём таблицу соответствия событий VPAID контейнера и событий из блока TrackingEvents, иначе говоря в ответ на событие VPAID container’a нужно засчитать событие из TrackingEvents:

Событие плеераСобытие из TrackingEvents
AdStarted creativeView
AdImpression impression
AdVideoStart start
AdVideoFirstQuartile firstQuartile
AdVideoMidpoint midpoint
AdVideoThirdQuartile thirdQuartile
AdVideoComplete complete

Подсчёт переходов для VPAID – контейнере

Стандартное поведение VPAID – контейнера предусматривает, что при переходе на сайт рекламодателя контейнер генерирует событие AdClickThru, необходимо слушать данное событие от контейнера и при его наступлении дёргать событие ClickTracking из пришедшего xml, в том числе wrapper.

Как мы уже говорили ранее, для случая Wrapper’a это событие заключает в себе ещё и подсчёт перехода в системе ADFOX.

Extension type="controls" отвечает за показ элементов управления плеера, где 1 – показывать, а 0 – скрыть, аналогично описанному во wrapper. 


4. Проверка правильности внедрения видео-рекламы в видео-плеер

1. Завести тестовую кампанию и тестовые баннеры для всех форматов:
a. Pre-roll, post-roll, mid-roll, pause-roll (VAST) – flv
b. Pre-roll, post-roll, mid-roll, pause-roll (VAST) – swf
c. Pre-roll, post-roll, mid-roll, pause-roll (VAST) – png/jpg/gif
d. Pre-roll, post-roll, mid-roll, pause-roll (Wrapper VAST)
e. Pre-roll, post-roll, mid-roll, pause-roll (Wrapper VAST + VPAID)
f. Overlay (VAST) - png/jpg/gif
g. Overlay (VAST) - swf
h. Overlay (Wrapper VAST)
i. Overlay (Wrapper VAST + VPAID)

2. Визуально проверить отображение всех видов баннеров:
a. Pre-roll, post-roll, mid-roll, pause-roll (VAST) – flv
b. Pre-roll, post-roll, mid-roll, pause-roll (VAST) – swf
c. Pre-roll, post-roll, mid-roll, pause-roll (VAST) – png/jpg/gif
d. Pre-roll, post-roll, mid-roll, pause-roll (Wrapper VAST)
e. Pre-roll, post-roll, mid-roll, pause-roll (Wrapper VAST + VPAID)
f. Overlay (VAST) - png/jpg/gif
g. Overlay (VAST) - swf
h. Overlay (Wrapper VAST)
i. Overlay (Wrapper VAST + VPAID)

3. Протестировать корректность запросов всех событий по каждому формату:

НазваниеСобытиеЗначение pm=
Ролик загруженimpressionpm=d
Ролик выбранcreativeViewpm=c
Начало просмотраstartpm=b
Первая четверть просмотраfirstQuartilepm=e
Середина просмотраmidpointpm=f
Третья четверть просмотраthirdQuartilepm=g
Окончание просмотраcompletepm=h
Клик на крестик закрытияclosepm=r
Выключить звукMute pm=i
Включить звукUnmute pm=j
Постановка рекламного ролика на паузуPausepm=k
Продолжение просмотра рекламного роликаResumepm=m

4. Протестировать корректность работы extensions. Своевременное появление плашек, кликабельность и события:

НазваниеСобытиеЗначение pm=
Пропустить рекламуskipAdpm=s
Перейти на сайт рекламодателяskipAdpm=t

5. Параметры, которые необходимо указать при заведении баннера в интерфейсе ADFOX

URL видео-ролика. Можно заливать FLV, MP4, WEBM, MOV, SWF, JPG, PNG, и статические GIF файлы.
Ссылка перехода. Ссылка на сайт рекламодателя.
Тип контента. По умолчанию - video/x-flv. Тип контента должен соответствовать загруженному файлу ролика:

НазваниеMIME-тип
FLVvideo/x-flv
MP4 video/mp4
WEBMvideo/webm
MOVvideo/quicktime
SWFapplication/x-shockwave-flash
JPGimage/jpeg
PNGimage/png
GIFimage/gif

Длительность (чч:мм:сс). По умолчанию - 00:00:00. Для статических файлов и SWF необходимо указывать точную длительность воспроизведения.
Время показа плашки "Пропустить рекламу" (мм:сс). По умолчанию - 00:00. Указывает с какой секунды показывать плашку "пропустить рекламу".
Текст на плашке перехода. По умолчанию - "перейти на сайт рекламодателя". Указывает текст для плашки перехода. 
Время показа крестика закрытия (мм:сс). По умолчанию - 00:00. Указывает с какой секунды показывать крестик закрытия.
Флаг кликабельности баннера. По умолчанию – 1 (клик обрабатывается) Для некоторых РК баннеры должны быть некликабельными. В таком случае 1 нужно заменить на 0.

Ссылка на аудит пиксель сторонней системы устанавливается в поле url для события 1

При создании РК метод учета показов – по событию 1