Общая информация
Платформа игр Одноклассников поддерживает возможность интеграции и запуска HTML5-приложений на всех мобильных платформах, доступных в нашей социальной сети - мобильный веб, нативные приложения Одноклассников на платформах Android и IOS.
Создание и настройка приложения
Для подключения поддержки вашей игры на мобильных платформах необходимо его правильно настроить. Для этого надо создать новое или отредактировать уже существующее веб-приложение, подключив у него платформу HTML (Mobile).
Если у вас вдруг всё еще нет приложения, то создать его можно по этой инструкции.
После создания приложения, либо если оно у вас уже есть, остается лишь включить платформу следующим образом:
Кроме этого вы можете закрепить желаемую ориентацию экрана на платформе android:
Интеграция с Одноклассниками
После того, как вы успешно настроили приложение, оно будет доступно по прямой ссылке вида https://m.ok.ru/game/gameId.
ID приложения можно получить из письма, которое приходило вам после создания приложения. В нём так же содержаться публичный и секретный ключи приложения, необходимые для взаимодействия с API Одноклассников. То есть письмо будет примерно таким:
Ваше приложение НАЗВАНИЕ ПРИЛОЖЕНИЯ успешно зарегистрировано на Одноклассниках.
Application ID: 1234567890. - id приложения, который вы можете использовать для идентификации приложения и досупа к нему по ссылке
Публичный ключ приложения: CBANANNANANANANA. - публичный ключ приложения, который используется для взаимодействия с API
Секретный ключ приложения: ABCDE1234567890ABCDE12345. секретный ключ приложения, который используется для взаимодействия с API. Никому не давайте его
Ссылка на приложение: https://ok.ru/game/1234567890 - ссылка на приложение на Одноклассниках. Для доступа к мобильной версии используйте домен m.ok.ru
При открытии вашего приложения на мобильной версии Одноклассников, либо в наших мобильных приложениях, оно будет открываться по URL, который указан в настройках приложения. Кроме это в URL будет передаваться ряд параметров, идентифицирующих пользователя, тип сессии и источник перехода.
Полный список параметров вы можете найти здесь.
Чтобы определить, что игра была открыта на мобильной платформе, передается особый параметр mob=true.
Подключение SDK
Для реализации взаимодействия с API Одноклассников со стороны HTML5-приложения необходимо использовать мультиплатформенное JS SDK.
Возможности API и SDK
После подключения JS SDK вы можете делать следующее:
- делать записи в ленту пользователя с помощью виджета публикации;
- приглашать/слать нотификации в игру с помощью виджета приглашения в игру;
- вызывать REST-методы.
Примеры приложений, которые реализуют это функционал:
Платежная система и монетизация
Для платформы Instant Games предусмотрено следующие возможности монетизации игры:
- внутриигровые покупки;
- внутриигровые подписки;
- rewarded реклама;
- interstitial реклама;
- баннерная реклама.
Для каждого из способов монетизации вы можете посмотреть примеры приложений:
- приложение с примером проведения платежа вы можете посмотреть здесь;
- приложение с примером показа рекламы располагается тут.
Также обратите внимание на рекомендации проведения платежей мобильных платежей
Для корректной работы платежной системы в настройках игры необходимо указать callback url для обработки платежей
Тестирование приложения
В любое время вы можете проверить, как хорошо работает ваше приложение.
Изначально оно доступно супервизору приложения (пользователь, создавший приложение на Одноклассниках). Для того, чтобы к приложению мог получить доступ другой пользователь, надо выполнить два простых шага:
- пользователь, которому предоставляется доступ к приложению, должен принять права разработчика;
- супервизор приложения должен добавить этого пользователя в список разработчиков приложения.
После этого пользователь должен иметь доступ к игре по прямой ссылка вида https://m.ok.ru/game/gameId. Эту ссылку можно открыть как в мобильном браузере (тогда приложение откроется на мобильной версии Одноклассников), так и внутри приложения Одноклассников на плафтормах Android и IOS.
Также для платформы Android все ваши игры с платформой MOBILE_HTML будут показываться в списке ваших игр в разделе игр. Но обратите внимание, что:
- вы должны быть разработчиком игры;
- у игры должна быть выбрана платформа MOBILE_HTML в настройках;
- для появления раздела моих игр вы должны запустить как минимум одну игру на мобильных платформах ОК.
Отладка приложения
Независимо от платформы, на которой запускается ваше приложение, у вас остается возможность доступа к режиму отладки в браузере.
Отладка на iOS
Наиболее распространенными способами запуска приложения на платформе iOS являются:
- запуск в Safari на мобильной версии Одноклассников - m.ok.ru;
- запуск в Safari через нативное приложение Одноклассников на платформе iOS.
В любом случае вы можете использовать режим отладки в Safari для отладки вашего приложения.
Инструкция по подключению режима удалённой отладки доступна по ссылке - safari remote inspector
Отладка на Android
Наиболее распространенными способами запуска приложения на платформе Android являются:
- запуск в Chrome на мобильной версии Одноклассников - m.ok.ru;
- запуск в Android Webview через нативное приложение Одноклассников на платформе Android.
И в том, и в другом случае для отладки можно использовать режим удаленной отладки в Chrome - android remote debugging
Обратите внимание, что в случае с запуском в Android Webview вам надо:
- запросить возможность дебага для вашей игры, написав заявку на почту api-support@ok.ru;
- убедиться, что версия ОС Android на устройстве - 4.4 и выше.
Требования к приложениям
Прежде чем разрабатывать приложение, ознакомьтесь, пожалуйста, с общими требованиями к играм на Одноклассниках: требования к играм
В дополнение к общим требованиям у HTML5-игр есть ряд характерных только для них требований:
- быть играбельным (не тормозить) на телефонах iPhone 5s и Nexus 5;
- корректно работать на современных веб браузерах и на мобильных браузерах операционных систем Android и iOS;
- На всех неподдерживаемых браузерах игра должна показывать заглушку с просьбой обновиться до последней версии текущего браузера или установить другой современный браузер.
Подробнее с требованиями вы можете ознакомиться в нашем чеклисте для мобильных приложений.
Модерация
Когда ваше приложение готово к публикации на Одноклассниках (разработка завершена и приложение удовлетворяет всем требования платформы), выберите приложение в каталоге и отправьте его на модерацию
В пункте формы Платформа надо выбрать вариант HTML мобильное приложение. Если вы всё заполнили верно, то вскоре вам придет письмо с доступами к нашей внутренней Jira, где с вами продолжат общение наши специалисты по модерации приложений.
FAQ
Если у вас появился какой-либо вопрос по платформе мобильных игр и его не оказалось в списке ниже, то можете задать его по почтовому адресу api-support@ok.ru.
Можно ли использовать одно приложение для нескольких платформ
Да, если у вас уже есть игра, доступная в веб-версии Одноклассников, то рекомендуется использовать это же приложение для реализации мобильной его версии. В таком случае это приложение будет иметь общую пользовательскую базу и настройки, что и веб-версия игры. Например, после прохождения модерации мобильной версией приложения оно автоматически появится в списке моих игр на Одноклассниках.