Методы
Методы вызываются у контроллера рекламы:
- в 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() | string | URL креатива. |
getAdCreativeType() | string | Тип креатива. |
getAdCreativeBannerId() | string | Идентификатор баннера. |
getAdIsNoBanner() | boolean | true, если в ответе нет рекламы. |
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. |