Параметры запуска
При запуске мини-приложения на URL, указанный в Настройках, передаются параметры запуска. Они содержат в себе данные о пользователе, запустившем мини-приложение, и об источнике запуска.
Чтобы программно получить параметры запуска, воспользуйтесь одним из следующих способов:
- •Извлеките значение свойства
hrefобъектаwindow.location. - •Вызовите событие
VKWebAppGetLaunchParams.
vk_user_id
integer
Идентификатор пользователя, запустившего мини-приложение.
Параметр
vk_user_idнужно использовать для авторизации пользователя в мини-приложении. Чтобы проверить подлинность полученных данных, вычислите подпись и сравните с полученным значениемsign.
vk_app_id
integer
Идентификатор мини-приложения.
vk_is_app_user
integer
Информация об установке пользователем мини-приложения:
- •
0— мини-приложение не установлено, - •
1— мини-приложение установлено.
vk_are_notifications_enabled
integer
Информация о разрешённых уведомлениях от мини-приложения:
- •
0— отправка уведомлений запрещена, - •
1— отправка уведомлений разрешена.
vk_language
string
Язык пользовательского интерфейса мини-приложения.
Возможные значения:
- •
ru— русский, - •
uk,ua— украинский, - •
en— английский, - •
be— белорусский, - •
kz— казахский, - •
pt— португальский, - •
es— испанский.
vk_ref
string
Источник запуска мини-приложения.
Возможные значения:
- •Категории в каталоге:
- •
catalog_recent— категория недавних; - •
catalog_favorites— категория избранных; - •
catalog_recommendation— категория рекомендуемых; - •
catalog_top_dau— категория популярных; - •
catalog_entertainment— категория развлечений; - •
catalog_communication— категория общение; - •
catalog_tools— категория инструментов; - •
catalog_shopping— категория покупок; - •
catalog_events— категория мероприятий; - •
catalog_education— категория образование; - •
catalog_payments— категория оплаты услуг; - •
catalog_finance— категория финансов; - •
catalog_food— категория еды и напитков; - •
catalog_health— категория красоты и здоровья; - •
catalog_travel— категория путешествий; - •
catalog_taxi— категория такси; - •
catalog_job— категория работы в каталоге; - •
catalog_realty— категория недвижимости; - •
catalog_business— категория бизнеса; - •
catalog_lifestyle— категория образа жизни; - •
catalog_admin— категория созданных.
- •
- •Обсуждения в сообществе:
- •
board_topic_all— предварительный просмотр обсуждений, где перечислены все обсуждения сообщества; - •
board_topic_view— экран обсуждения, где отображены все комментарии обсуждения.
- •
- •Лента:
- •
feed— вкладка Новости ленты новостей; - •
feed_post— ссылка записи без сниппета; - •
feed_comments— комментарий к записи.
- •
- •Фичеринг:
- •
featuring_discover— блок рекомендаций в ленте новостей; - •
featuring_menu— блок Мини-приложения в мобильной версии сайта (m.vk.com); - •
featuring_new— виджет на вкладке Для вас приложения ВКонтакте.
- •
- •Закладки:
- •
fave— общий список закладок; - •
fave_links— вкладка Ссылки закладок; - •
fave_posts— вкладка Записи закладок.
- •
- •Сообщества:
- •
group— стена сообщества; - •
group_menu— меню сообщества (Android); - •
group_messages— сообщения сообщества; - •
group_addresses— адрес сообщества.
- •
- •Сниппеты:
- •
snippet_post— сниппет записи; - •
snippet_im— сниппет в личных сообщениях.
- •
- •Клипы:
- •
clips— экран клипов (iOS); - •
comments_list_clip— из комментариев к клипу (Android);
- •
- •Чаты:
- •
im— предварительный просмотр чата; - •
im_chat— экран чата.
- •
- •Уведомления:
- •
notifications— заблокированный экран, где сгруппированы уведомления; - •
notifications_grouped— экран сгрупированных уведомлений; - •
notifications_auto— одно или сгруппированное автоматическое уведомление.
- •
- •
super_app— вкладка Сервисы приложения ВКонтакте. - •
profile— записи профиля; - •
article_read— статья сообщества; - •
music_playlist— музыкальный плейлист; - •
video_carousel— видео (iOS); - •
photo_browser— экран просмотра фотографий записи (iOS); - •
shopping_center— лента товаров (iOS); - •
market_item— экран товара; - •
story${user_id}_${params}— история; - •
widget— виджет на вкладке Сервисы приложения ВКонтакте; - •
showcase— витрина на вкладке Сервисы приложения ВКонтакте; - •
home_screen— домашний экран устройства (Android); - •
left_nav— левое меню в десктопной версии сайта (vk.com); - •
quick_search— результаты быстрого поиска; - •
menu— блок Мини-приложения на вкладке Ещё в мобильной версии сайта (m.vk.com); - •
other— прочие источники.
vk_access_token_settings
string
Список прав доступа текущего пользователя в мини-приложении. Например: "friends, video, photos".
vk_group_id
integer
Идентификатор сообщества, если мини-приложение запущено из сообщества. Информация о группе возвращается, если:
- •мини-приложение запущено с помощью кнопок в сообществе или из блока приложений сообщества;
- •исходная ссылка на мини-приложение имела вид:
vk.com/app12345_-12345.
vk_viewer_group_role
string
Роль пользователя в сообществе, из которого запущено мини-приложение:
- •
admin— администратор или создатель сообщества, - •
editor— редактор сообщества, - •
member— подписчик сообщества, - •
moder— модератор сообщества, - •
none— не состоит в сообществе.
Информация о сообществе возвращается, если:
- •мини-приложение запущено с помощью кнопок в сообществе;
- •исходная ссылка на приложение имела вид:
vk.com/app6909581_-166562603.
vk_platform
string
Платформа, на которой запущено мини-приложение:
- •
desktop_web— десктопная версия сайта, - •
mobile_android— мобильное приложение для Android, - •
mobile_android_messenger— мобильный мессенджер для Android, - •
mobile_ipad— приложение для iPad, - •
mobile_iphone— мобильное приложение для iPhone, - •
mobile_iphone_messenger— мобильный мессенджер для iPhone, - •
mobile_web— мобильная версия сайта.
Платформа, на которой запущено мини-приложение вне приложения ВКонтакте:
- •
android_external— мобильное приложение для Android, - •
iphone_external— мобильное приложение для iPhone, - •
ipad_external— приложение для iPad, - •
web_external— десктопная версия сайта, - •
mvk_external— мобильная версия сайта.
vk_is_favorite
integer
Информация о добавлении мини-приложения в избранное:
- •
0— мини-приложение не добавлено в избранное, - •
1— мини-приложение добавлено в избранное.
vk_ts
integer
Время генерации подписи параметров запуска. Подпись передаётся в параметре sign.
vk_is_recommended
integer
Информация о том, порекомендовано ли мини-приложение. Значение 1 означает, что мини-приложение порекомендовано. Если мини-приложение не порекомендовано, параметр не передаётся.
vk_profile_id
Идентификатор пользователя, из профиля которого мини-приложение запускается. Используется в кнопке мини-приложения в профиле пользователя.
sign
string
Подпись переданных параметров. Нужна, чтобы убедиться, что параметры валидны и не были модифицированы при передаче.
odr_enabled
integer
Информация о запуске мини-приложения в режиме ODR. Значение 1 означает, что мини-приложение запущено в режиме ODR. Если мини-приложение не запущено в режиме ODR, параметр не передаётся.
Произвольный параметр
Вы можете передать в параметры запуска мини-приложения произвольные параметры. Для этого используйте в адресе ссылки символ #, после которого укажите необходимые значения. Они вернутся вместе с параметрами запуска после символа #.
Чтобы получить произвольный параметр программно, извлеките значение свойства hash объекта window.location.