Это старая версия рекламного API. Рекомендуем использовать новую версию API - FAPI.UI.loadAd
Сигнатура метода
FAPI.invokeUIMethod("prepareMidroll");Пример вызова
/*
* Функция инициирует подготовку рекламы для показа пользователю во время игровой сессии
*/
function prepareMidroll() {
FAPI.invokeUIMethod("prepareMidroll");
}Пример коллбека
В результате выполнения функции в параметре data указывается информация о том, найдено ли видео для показа.
Коллбек для случая, если видео для показа найдено
method: “prepareMidroll”
result: “ok”
data: “ready”
Коллбек для случая, когда видео не найдено
method: “prepareMidroll”
result: “error”
data: “empty”
Коллбек для случая, когда показ видео недоступен для пользователя
method: “prepareMidroll”
result: “error”
data: “disabled”
Детализация ошибок рекламы на Android
В случае возникновения ошибки при попытке поиска рекламы на платформе Android вам будет возвращена ошибка вида native ads failed: error_code.
Параметр error_code может иметь следующие значения:
- -1 - достигнут лимит частоты вызова рекламы. Вызов метода доступен не чаще 1 раза в 30 секунд;
- -2 - ошибка вызова клиентского коллбека;
- -3 - реклама на Android недоступна пользователю (например, он использует старую версию приложения);
- -4 - в данный момент уже идёт показ рекламы.
Как это работает
При вызове функции производится поиск рекламы, которая может быть показана пользователю во время игровой сессии.
Подбор видео является персонализированным и зависит от характеристик пользователя.
После вызова метода по подготовке рекламы необходимо использовать метод FAPI.invokeUIMethod(“showMidroll”) для её показа пользователю.
Показ необходимо инициировать только если реклама для показа была найдена.
Тестовое приложение
Чтобы проверить, как именно выглядит и работает реклама, можно воспользоваться тестовым приложением, которое доступно по следующим ссылкам:
- приложение для полной версии сайта - https://ok.ru/app/video_adv_test
- приложение для мобильной версии сайта - https://m.ok.ru/app/video_adv_test
Чтобы увидеть рекламу в приложении для полной версии сайта, достаточно сделать следующее:
- нажать на кнопку “prepare midroll”;
- нажать на кнопку “show midroll”.
А для мобильной версии:
- нажать на кнопку “inject frame”;
- нажать на кнопку “prepare midroll”;
- нажать на кнопку “show”.
Статистика
На странице вашей игры в разделе со статистикой показываются данные о том, сколько рекламных видео просмотрели ваши пользователи.
Учтите, что для платорм web, mobile web и ios мы считаем показ успешным, если:
- просмотр рекламы пользователем длился как минимум 10 секунд;
- показ рекламы был успешно завершен (вам должен был прийти ответ showMidroll$ok$complete).
Для платформы android мы считаем показ успешным, если после вызова метода показа вернулся ответ ad_shown.