Общая информация

На нашей платформе появляется возможность публикации нового класса игр - гиперказуальных игр.

Мы желаем как можно сильнее упростить процесс интеграции и запуска на нашей платформе для таких игр, например:

• не нужна обязательная монетизация с помощью in-app-платежей. Достаточным условием запуска игры на платформе является наличие рекламной монетизации;
• не требуется (хоть и приветствуется) использование социальных механик, таких как публикация топиков, отправка инвайтов, взаимодействие с соц. графом пользователя;
• предполагается наличие отдельных механизмов фичеринга для игр данного жанра.

Что вам потребуется для интеграции запуска такой игры на нашей платформе:

• получить права разработчика;
• создать отдельное приложение в Одноклассниках и правильно его настроить;
• добавить в вашу игру привязку к профилю в ОК. Все необходимые данные о пользователе будут передаваться вам при запуске игры;
• реализовать в вашей игре рекламную монетизацию, используя наше SDK;
• подать заявку на модерацию и пройти её.

Получение прав разработчика

Для доступа к разделу разрабатываемых приложений вам нужно получить права тут или на этой странице: ok.ru/devaccess

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

Создание и настройка приложения

После того, как вы получили права разработчика, необходимо создать приложение согласно этой инструкции

Вам требуется создать приложение, выбрав у него платформы:

• web;
• мобильное.

В качестве ссылки на приложение в настройках надо указать адрес, по которому доступна ваша игра.

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

• id приложения - уникальный идентификатор приложения;
• секретный ключ приложения - нужен для доступа к настройкам приложения;
• публичный ключ приложения - нужен для работы с API OK;

Все эти данные требуется сохранить.

После настройки игры она будет доступна владельцу игры по следующим URL’ам:

• https://m.ok.ru/game/appId - на мобильных платформах;
• https://ok.ru/game/appId - на десктопе.

На мобильных устройствах ваше приложение будет показываться прямо на главной странице раздела игр в специальном разделе с вашими загруженными играми.

Добавление новых разработчиков в игру

Если на этапе разработки какому-то другому пользователю потребуется доступ к приложению (например, для разработки или тестирования), то для этого нужно:

• получить права разработчика тут или здесь;
• добавить владельца приложения в друзья на ОК;
• владелец приложения должен добавить пользователя в разработчики приложения согласно этой инструкции

Ссылки:

• инструкция по созданию приложения
• добавление новых разработчиков

Получение данных о пользователе

После того, как ваше приложение корректно настроено, при запуске по ссылке вида https://ok.ru/game/gameId игра будет открываться на наших платформах в iframe.

Адрес iframe берется из настроек приложения, а в query этого URL’а мы передаём всю нужную игре информацию о пользователе:

• logged_user_id - id пользователя;
• user_name - имя и фамилия пользователя;
• user_image - ссылка на аватар пользователя;
• user_gender - пол пользователя. 1 - мужской, 2 - женский.

Также игре передаётся большое количество других параметров, полный список которых вы можете получить по этой ссылке.

Рекламная монетизация

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

• rewarded ads - реклама, показ которой подразумевает награждение за просмотр;
• interstitial ads - реклама, которую можно показывать в перерывах между игровым процессом.

Подключить SDK достаточно просто, надо лишь:

• подключить FAPI в проект;
• объявить функцию для обработки результата вызова (callback-функция);
• реализовать вызов методов SDK для поиска и показа рекламы.

Rewarded ads

Для реализации этого формата рекламы в вашей игре в SDK реализовано два метода, которые позволяют:

• выполнить запрос на поиск рекламы - FAPI.UI.loadAd;
• показать найденную рекламу - FAPI.UI.showLoadedAd.

Эти методы работаю на всех платформах (десктопный и мобильный веб, android, iOS).

Interstitial ads

Для реализации этого формата рекламы требуется использовать лишь один метод:

• выполнить запрос на поиск и показ рекламы - FAPI.UI.showAd.

Подключение FAPI

В код вашего приложения надо добавить следующую строчку:

<script type="text/javascript" src="//api.ok.ru/js/fapi5.js" defer="defer"></script>

Callback-функция

Методы из группы FAPI.UI не требуют передачи callback-функции при вызове. После выполнения метода будет вызвана глобальная функция, которую должен реализовать разработчик. Функция должна иметь следующую сигнатуру:

function API_callback(method, result, data);

Здесь:

• method - название вызванного метода;
• result - результат выполнения (“ok” в случае успеха, “cancel” в случае, если пользователь отменил действие);
• data - дополнительная информация, например, для showInvite() – это список id приглашенных друзей, разделенный запятыми, в формате строки.

Поиск rewarded рекламы

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

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

Показ rewarded рекламы

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

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

Поиск и показ interstitial рекламы

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

/*
* Функция запускает поиск показ interstitial рекламы пользователю
*/
function showInterstitialAd() {
    FAPI.UI.showAd()
}

Модерация приложения

Последний этап перед попаданием вашей игры в каталог игр в ОК - модерация приложения.

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

Если заявка подана верно, то через какое-то время на почту, указанную в заявке, вам придёт письмо со всеми данными, необходимым для доступа к JIRA.

Всё дальнейшее взаимодействие будет осуществляться в рамках этого сервиса.