Skip to content

Методы

Методы вызываются у контроллера рекламы:

  • в WebView — window.myAdController;
  • в браузере — controller.loader, где controller возвращает adSDK.init().

Управление показом

МетодОписание
loadAd(url, settings)Загрузить рекламу по VAST-ссылке. В WebView SDK вызывает его сам при открытии страницы.
playAd()Начать или возобновить показ.
pauseAd()Поставить показ на паузу.
stopAd()Завершить показ и освободить ресурсы.
skipAd()Пропустить ролик. Вызывайте после AdSkippableStateChanged со status: true.
clickAd()Перейти по рекламе, как если бы пользователь нажал на креатив.
errorAd()Прервать показ с ошибкой. SDK отправит VAST-ошибку 403 и пришлёт AdError.
disableAd()Сообщить об отключении рекламы. SDK присылает AdDisable.
setVolume(level)Установить громкость от 0 до 1.
setMuted(muted)Включить (true) или выключить (false) беззвучный режим.
resizeAd(width, height, viewMode)Сообщить плееру новый размер. viewMode'fullscreen' или 'normal'. SDK сам отслеживает изменение размера окна, вызывать метод нужно, если меняется только контейнер.
timeupdateAd(time, duration)Сообщить SDK время воспроизведения в плеере приложения, в секундах. Только WebView. Вызывайте при каждом обновлении времени плеера и timeupdateAd(duration, duration) в конце ролика. См. Сценарий показа.
setFocusToPlayer()Передать фокус интерактивному креативу. Нужно на Android TV и в браузере для управления с клавиатуры.
destroy()Остановить показ и отписать все обработчики.

Только в браузере:

МетодОписание
on(name, callback)Подписаться на событие. Возвращает { unsubscribe() }.
off(name, callback)Отписаться от события.

Информация о рекламе

Значения доступны после события AdLoaded. Поля из расширений VAST равны null, если расширения нет.

Креатив

МетодТипОписание
getAdCreativeSrcURL()stringURL креатива.
getAdCreativeType()stringТип креатива.
getAdCreativeBannerId()stringИдентификатор баннера.
getAdIsNoBanner()booleantrue, если в ответе нет рекламы.
getAdDuration()numberДлительность ролика в миллисекундах.
getAdDurationInSec()numberДлительность ролика в секундах.
getAdCurrentTimeSec()numberТекущая позиция воспроизведения в секундах. Если видео играет плеер приложения — последнее значение из timeupdateAd().
getAdClickThroughUrl()stringСсылка перехода на сайт рекламодателя.

Пропуск

МетодТипОписание
getAdSkippableState()booleanМожно ли пропустить ролик прямо сейчас.
getAdIsSkippable()booleanПоддерживает ли ролик пропуск.
getAdSkipTimeOffsetSec()numberЧерез сколько секунд от начала можно пропустить ролик (из VAST skipoffset).
getAdSkipTime()number | nullЧерез сколько секунд можно пропустить рекламу (расширение skipTime).
getAdSkipTime2()number | nullЧерез сколько секунд можно закрыть рекламу (расширение skipTime2).

Рекламный блок

МетодТипОписание
getAdIsPod()booleanРеклама — блок из нескольких роликов.
getAdPodLength()numberЧисло роликов в блоке.

Маркировка и расширения VAST

МетодТипОписание
getAdTune()object | nullДанные маркировки: show (1 / 0) — показывать ли, token — ERID, advertiserInfo — информация о рекламодателе.
getAdTitle()object | nullМетка рекламы: show (1 / 0), domain, socialAdvertising (1 / 0).
getAdTitleText()stringГотовый текст метки: «Реклама», «Социальная реклама» или домен.
getAdLinkTxt()string | nullТекст призыва перейти на сайт рекламодателя.
getAdStartTime()number | nullЧерез сколько секунд от начала показывать текст linkTxt.
getAdIsClickable()boolean | nullМожно ли нажимать на креатив.
getAdCloseAct()boolean | nullЧто делать после перехода по рекламе: true — закрыть, false — поставить на паузу.
getAdSkipAd()string | nullСсылка трекинга пропуска рекламы.
getAdAddClick()string | nullСсылка, которая открывается при переходе на сайт рекламодателя.
getAdFiveSecondPoint()string | nullСсылка трекинга, которая вызывается через 5 секунд после начала ролика.
getAdExtensions()MapВсе расширения VAST.