События VK Bridge

На странице представлены события, которые поддерживаются в Одноклассниках. Некоторые события имеют отличия при работе ВКонтакте и в Одноклассниках. Мы указали это в таблице. Учитывайте это при разработке приложений.

Служебные

Событие	Платформы	Особенности
VKWebAppInit Инициализировать VK Bridge.	Android iOS Mobile Web Web
VKWebAppGetLaunchParams Получить параметры запуска приложения.	Android iOS Mobile Web Web	В параметре `vk_platform` передаётся платформа, на которой запущено приложение: • `desktop_web_ok` — десктопная версия сайта. • `mobile_android_ok` — приложение для Android. • `mobile_iphone_ok` — приложение для iOS. • `mobile_web_ok` — мобильный браузер.
VKWebAppGetClientVersion Получить информацию о платформе ВКонтакте, на которой запущено приложение.	Android iOS Mobile Web Web	В поле `platform` возвращается: • `web-ok` — если приложение запущено в десктопной версии сайта. • `android` — если приложение запущено в мобильном клиенте для Android. • `ios` — если приложение запущено в мобильном клиенте для iOS. • `mobile-web-ok` — если приложение запущено в мобильном браузере.
VKWebAppCallAPIMethod Вызвать метод API ВКонтакте.	Android iOS Mobile Web Web	Параметр `use_local` определяет, к какому API отправляется запрос. Возможные значения: • `true` — к API площадки, которая использует SDK, например API Одноклассников. • `false` — к API Вконтакте. Значение по умолчанию.

Доступы и разрешения

Событие	Платформы	Особенности
VKWebAppGetAuthToken Запросить доступ к данным пользователя.	Android iOS Mobile Web Web	Параметр `append_local` казывает, для какой площадки нужно получить ключ. Возможные значения: • `true` — получить ключ для площадки, которая использует SDK (например, Одноклассники). • `false` — получить ключ для ВКонтакте. Значение по умолчанию. Ключ доступа вернётся в ответе в поле `local_access_token`.
VKWebAppCheckAllowedScopes Получить список данных, к которым у приложения есть доступ.	iOS Mobile Web Web
VKWebAppGetGrantedPermissions Получить список разрешений, выданных мобильному приложению Одноклассники.	Android iOS

Внешний вид

Событие	Платформы	Особенности
VKWebAppResizeWindow Изменить размер окна приложения.	Web
VKWebAppSetViewSettings Настроить вид элементов управления приложением: статус-бара, экшен-бара, панели навигации.	Android iOS

Событие	Платформы	Особенности
VKWebAppSetLocation Задать значение хеша в адресной строке для навигации внутри приложения.	Android Mobile Web Web
VKWebAppSetSwipeSettings Включить жест «смахнуть назад» (свайп).	iOS
VKWebAppOpenApp Открыть другое приложение из текущего.	Mobile Web Web	Параметр `app_is_local` определяет, приложение какой площадки должно быть открыто. Возможные значения: • `true` — открыть приложение площадки, которая использует SDK (например, Одноклассники). • `false` — открыть мини-приложение ВКонтакте. Значение по умолчанию.
VKWebAppClose Закрыть приложение.	Android iOS Mobile Web Web
VKWebAppScroll Прокрутить окно приложения по вертикали.	Mobile Web Web
VKWebAppScrollTop Получить текущую позицию прокрутки относительно верха родительского окна приложения.	Web
VKWebAppScrollTopStart Начать отправку событий о прокрутке родительского окна.	Web
VKWebAppScrollTopStop Остановить отправку событий о прокрутке, начатых событием. `VKWebAppScrollTopStart`	Web

Монетизация

Событие	Платформы	Особенности
VKWebAppCheckNativeAds Проверить, есть ли на стороне пользователя рекламные материалы, доступные для показа.	Android iOS Mobile Web Web
VKWebAppShowNativeAds Показать рекламу.	Android iOS Mobile Web Web

Баннеры

Событие	Платформы	Особенности
VKWebAppShowBannerAd Показать баннерную рекламу.	Android iOS Mobile Web Web
VKWebAppCheckBannerAd Проверить, была ли показана баннерная реклама.	Android iOS Mobile Web Web
VKWebAppBannerAdUpdated Получить статус обновления баннерной рекламы.	Android iOS Mobile Web Web
VKWebAppHideBannerAd Скрыть баннерную рекламу.	Android iOS Mobile Web Web
VKWebAppBannerAdClosedByUser Сообщить, что пользователь закрыл баннер рекламы.	Android iOS Mobile Web Web

Покупки

Событие	Платформы	Особенности
VKWebAppShowOrderBox Открыть окно покупки товара.	Android iOS Mobile Web Web
VKWebAppShowSubscriptionBox Показать окно покупки, отмены или восстановления подписки.	Android iOS Mobile Web Web

Аналитика

Событие	Платформы	Особенности
VKWebAppRetargetingPixel Добавить пользователя в аудиторию ретаргетинга.	Android iOS Mobile Web Web
VKWebAppTrackEvent Отправить данные в MyTracker.	Android iOS Mobile Web Web

Пользователи

Событие	Платформы	Особенности
VKWebAppGetEmail Запросить доступ к адресу электронной почты пользователя.	iOS Mobile Web Web
VKWebAppGetFriends Показать список друзей пользователя.	Android iOS Mobile Web Web
VKWebAppGetPhoneNumber Запросить доступ к номеру телефона пользователя.	iOS Mobile Web Web
VKWebAppOpenContacts Запросить доступ к контактам из телефонной книги пользователя.	Android iOS
VKWebAppGetUserInfo Получить данные из профиля пользователя.	Android iOS Mobile Web Web	Параметр `use_local` определяет, с какой площадки нужно получить данные. Возможные значения: • `true` — с площадки, которая использует SDK, например Одноклассники. • `false` — ВКонтакте. Значение по умолчанию.

Сообщества

Событие	Платформы	Особенности
VKWebAppAddToCommunity Добавить приложение в сообщество.	Android iOS Mobile Web Web
VKWebAppAllowMessagesFromGroup Получить разрешение на отправку сообщений от имени сообщества.	Android iOS Mobile Web Web
VKWebAppGetGroupInfo Получить информацию о сообществе.	Android iOS Mobile Web Web
VKWebAppJoinGroup Предложить пользователю вступить в сообщество.	Android iOS Mobile Web Web
VKWebAppLeaveGroup Предложить пользователю выйти из сообщества.	Android iOS Mobile Web Web

Социальные механики и взаимодействие

Событие	Платформы	Особенности
VKWebAppShare Поделиться ссылкой.	Android iOS Mobile Web Web	• В вебе и мобильном браузере можно поделиться только записью на стене. • На Android и iOS: на стене, на стене сообщества, в личных сообщениях, дополнить текстом и отправить в ленту, отправить в приложение или скопировать ссылку
VKWebAppShowStoryBox Открыть редактор историй.	Android iOS Mobile Web Web	• Для поля `background_type` поддерживается только значение `image`. • Для `blob` поддерживаются значения `JPEG`, `PNG`, `SVG`. • В объекте `attachment` у параметра `type` поддерживается только значение `url`
VKWebAppOpenWallPost Открыть запись со стены в слое.	iOS Mobile Web Web	Если запись опубликована пользователем, то в `owner_id` нужно указать идентификатор пользователя. Если запись опубликована в группе, то нужно указать значение `0`
VKWebAppShowInviteBox Пригласить друзей в игру.	Android iOS Mobile Web Web	Для игр, запущенных в десктопной и мобильной версии сайта Одноклассники, необходимо обязательно передавать параметр `message`
VKWebAppShowRequestBox Отправить пользователю запрос о помощи в игре.	iOS Mobile Web Web
VKWebAppAllowNotifications Запросить разрешение на отправку уведомлений.	Android iOS Mobile Web Web
VKWebAppDenyNotifications Отключить уведомления.	Android iOS Mobile Web Web

Текст и медиафайлы

Событие	Платформы	Особенности
VKWebAppCopyText Копировать текст в буфер обмена.	Android iOS Mobile Web Web
VKWebAppDownloadFile Скачать файл на устройство.	Android
VKWebAppOpenCodeReader Считать QR-код.	Android iOS
VKWebAppShowImages Открыть нативный экран для просмотра изображений.	Android iOS Mobile Web
VKWebAppTranslate Перевести текст на другой язык.	Android iOS Mobile Web Web

Хранилище VK Storage

Событие	Платформы	Особенности
VKWebAppStorageSet Создать пару «ключ — значение».	Android
VKWebAppStorageGet Получить значение ключа.	Android
VKWebAppStorageGetKeys Получить названия всех переменных.	Android

Аутентификация

События этой группы доступны только для мини-приложений.

Событие	Платформы	Особенности
VKWebAppSecureTokenRequestAccess Запросить у пользователя разрешение на использование биометрии в качестве способа аутентификации в приложении.	iOS
VKWebAppSecureTokenSet Сохранить в защищённое хранилище произвольную строку, которая будет использоваться как ключ доступа.	iOS
VKWebAppSecureTokenGet Запустить проверку биометрии и после её успешного прохождения получить ключ доступа из защищённого хранилища.	iOS
VKWebAppSecureTokenGetInfo Получить информацию о том, доступна ли на устройстве биометрия.	iOS
VKWebAppSecureTokenRemove Удалить из защищённого хранилища ключ доступа, который был сохранён для аутентификации пользователя с помощью биометрии.	iOS

Мобильные устройства

Виброотклик

Событие	Платформы	Особенности
VKWebAppTapticImpactOccurred Вызвать вибрацию при столкновении.	iOS
VKWebAppTapticNotificationOccurred Вызвать вибрацию после выполнения действия.	iOS
VKWebAppTapticSelectionChanged Вызвать вибрацию при изменении выбора пользователем.	iOS

Фонарик

Событие	Платформы	Особенности
VKWebAppFlashGetInfo Получить информацию о фонарике.	Android iOS
VKWebAppFlashSetLevel Задать уровень яркости фонарика.	Android iOS

Датчики

Событие	Платформы	Особенности
VKWebAppAccelerometerStart Отслеживать данные акселерометра.	Android iOS
VKWebAppAccelerometerStop Прекратить отслеживание данных акселерометра.	Android iOS
VKWebAppDeviceMotionStart Отслеживать данные о положении устройства.	Android iOS
VKWebAppDeviceMotionStop Прекратить отслеживание данных о положении устройства.	Android iOS
VKWebAppGyroscopeStart Отслеживать данные гироскопа.	Android iOS
VKWebAppGyroscopeStop Прекратить отслеживание данных гироскопа.	Android iOS