Параметры
Эти параметры передаются в адресе страницы SDK при интеграции в WebView. В браузере те же настройки задаются полями объекта settings, см. Интеграция в браузер.
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
url | string | да | Ссылка на VAST-тег |
os | string | нет | Платформа, если её нет в пути адреса |
lang | string | нет | Язык интерфейса |
controls | JSON-массив | нет | Элементы управления |
autoplay | boolean | нет | Начать показ без вызова playAd() |
ad_media_file_width | number | нет | Желаемая ширина видео |
ad_media_max_duration_sec | number | нет | Максимальная длительность рекламы |
debug | string | нет | Отладочный вывод в консоль |
Параметры, которых нет в таблице, SDK добавляет к VAST-ссылке без изменений.
url
Ссылка на VAST-тег. Закодируйте её через encodeURIComponent.
Если в ссылке встречается , SDK подставит вместо него свою версию.
Если параметра нет, SDK присылает AdError с кодом 1.
os
Платформу задаёт путь адреса: /android/, /androidtv/ или /ios/ — см. адрес страницы. Параметр os нужен только старым интеграциям, которые открывают страницу без платформы в пути.
Если платформа есть и в пути, и в os, используется путь. Без обоих платформа определяется по userAgent, а если определить её не удалось — используется android.
Значение web в WebView не поддерживается: SDK присылает AdError с кодом web_ui_in_native_build. Для браузера используйте браузерный пакет.
lang
Язык интерфейса SDK. По умолчанию en.
| Код | Язык | Код | Язык |
|---|---|---|---|
ar | Арабский | pt | Португальский |
en | Английский | ru | Русский |
es | Испанский | sw | Суахили |
fr | Французский | tr | Турецкий |
hi | Хинди | uz | Узбекский |
ky | Киргизский |
controls
JSON-массив элементов управления, например ["ad-skip-btn","ad-more-menu"]. Значение "all" включает все элементы. Список — в разделе Элементы управления.
autoplay
Показ начнётся сразу после загрузки, без вызова playAd().
Включают автозапуск значения true, 1, yes и параметр без значения (&autoplay). Выключают — false, 0, no. Любое другое значение не учитывается, автозапуск выключен.
ad_media_file_width
Желаемая ширина видео в физических пикселях (не в CSS-пикселях). SDK выбирает из VAST видеофайл с ближайшей шириной, а при равном отклонении — больший.
Нужно положительное целое число. Если значение не передано или некорректно, качество подбирается автоматически по размеру плеера и скорости соединения.
ad_media_max_duration_sec
Максимальная длительность рекламы в секундах. Нужно положительное целое число, иначе параметр не учитывается.
debug
debug=true включает вывод отладочных сообщений SDK в консоль WebView.
Пример
https://cdn.adsdk.ru/android/v3/?url=https%3A%2F%2Fexample.com%2Fvast.xml&lang=ru&controls=%5B%22ad-skip-btn%22%2C%22ad-more-menu%22%5D&ad_media_file_width=1080