Сигнатура метода

Для получения вознаграждения по рекламе необходимо заключить договор по ссылке:

FAPI.UI.loadAd();

Пример вызова

/*
* Функция инициирует подготовку рекламы для показа пользователю во время игровой сессии
*/
function loadRewardedAd() {
    FAPI.UI.loadAd();
}

Пример коллбека

В результате выполнения функции в параметре data указывается информация о том, найдено ли видео для показа.

Коллбек для случая, если видео для показа найдено

method: “loadAd”

result: “ok”

data: “ready”

Коллбек для случая, когда видео не найдено

method: “loadAd”

result: “error”

data: “empty”

Коллбек для случая, когда показ видео недоступен для пользователя

method: “loadAd”

result: “error”

data: “disabled”

Детализация ошибок рекламы на Android

В случае возникновения ошибки при попытке поиска рекламы на платформе Android вам будет возвращена ошибка вида native ads failed: {error_code}.

Параметр error_code может иметь следующие значения:

  • -1 - достигнут лимит частоты вызова рекламы. Вызов метода доступен не чаще 1 раза в 30 секунд;
  • -2 - ошибка вызова клиентского коллбека;
  • -3 - реклама на Android недоступна пользователю (например, он использует старую версию приложения);
  • -4 - в данный момент уже идёт показ рекламы.

Детализация успешного вызова рекламы на Android

В случае успешного вызова метода поиска рекламы и её дальнейшего показа, на плафторме android при вызове callback-функции в data вам будут передаваться следующие данные в процессе использования API рекламы:

  • метод loadAd:
    • data = ad_prepared - этот коллбек означает, что реклама подготовлена и может быть показана;
  • метод showLoadedAd:
    • data = ad_shown - этот коллбек означает, что реклама успешно показана пользователю, показ засчитан в статистику показов.

Как это работает

При вызове функции производится поиск рекламы, которая может быть показана пользователю во время игровой сессии.
Подбор видео является персонализированным и зависит от характеристик пользователя.
После вызова метода по подготовке рекламы необходимо использовать метод FAPI.UI.showLoadedAd для её показа пользователю.
Показ необходимо инициировать только если реклама для показа была найдена.

Тестовое приложение

Чтобы проверить, как именно выглядит и работает реклама, можно воспользоваться тестовым приложением, которое доступно по следующим ссылкам:

Чтобы увидеть рекламу в приложении для полной версии сайта, достаточно сделать следующее:

  • нажать на кнопку “load rewarded ad”;
  • нажать на кнопку “show rewarded ad”.

Статистика

Статистика по показам доступна на странице игровой статистики:

  • вкладка “Реклама” -> график “Показы рекламы в браузере” - для рекламы на платформах web, mobile web, ios (включен в mobile web);
  • вкладка “Реклама” -> график “Показы рекламы на платформе Android” - для рекламы на платформе android.

Учтите, что для платорм web, mobile web и ios мы считаем показ успешным, если:

  • просмотр рекламы пользователем длился как минимум 10 секунд;
  • показ рекламы был успешно завершен (вам должен был прийти ответ с result = ok и data = complete).

Для платформы android мы считаем показ успешным, если после вызова метода показа вернулся ответ ad_shown.

API статистики

Также вы можете собирать и анализировать статистику по рекламе самостоятельно с помощью API игровой статистики:

  • метод - stat.getFromServer;
  • статистическая таблица app_video_adv_external - для сбора статистики по рекламе на платформах web, mobile web, ios;
  • статистическая таблица ad_shown_android - для сбора статистики по рекламе на платформе android.