События из мини-приложения в VK Рекламу: VKWebAppTrackEvent
События из мини-приложения или игры VK отправляют методом VKWebAppTrackEvent (VK Bridge): bridge.send с обязательным полем event_name и необязательным user_id. Данные идут в VK Рекламу и, если подключён, в MyTracker. Платформы: Android, iOS, Mobile Web, Web. Инструмент в бете и подключается по запросу на support@tracker.my.com.
Цифры
Параметры вызова
| Поле | Тип | Обязательность | Описание |
|---|---|---|---|
| event_name | string | обязательное | тип события, произвольная строка |
| user_id | string | необязательное | идентификатор пользователя в мини-приложении или игре |
Значения event_name
| Значение | Что означает |
|---|---|
| subscribe | подписаться на рассылку |
| unsubscribe | отписаться от рассылки |
| registration | регистрация |
| login | авторизация |
| purchase | покупка |
| add_to_cart | добавление в корзину |
| search | поиск |
| lead | оформление заявки (лид) |
| product_card | просмотр карточки товара |
| enroll_in_course | записаться на курс |
| take_test | пройти тест |
| visit_website | посетить сайт |
| view_info_page | просмотр информационной страницы |
| view_contacts | просмотр контактов |
| download | скачать |
Ответ метода (Promise)
| Поле | Тип | Описание |
|---|---|---|
| result | boolean | true, если данные успешно отправлены |
При ошибке управление уходит в catch, там приходит объект с информацией об ошибке, общий для всех событий VK Bridge.
Подробности
Для кого страница и что нужно
Описание написано для разработчиков, полная документация метода лежит в разделе VK Bridge на dev.vk.ru. Метод отправляет данные из мини-приложения или игры в VK Рекламу и в систему аналитики MyTracker, если она подключена. «Трекинг мини-приложений» находится в бета-тестировании, подключение — по запросу на почту support@tracker.my.com. Справка по платформам и настройке в MyTracker — отдельная страница документации MyTracker.
Как выглядит вызов
Вызов: bridge.send с первым аргументом VKWebAppTrackEvent и вторым — объектом с полями. В примере справки передают event_name со значением login и user_id со строкой из цифр. К вызову подключают обработчики: then (в нём проверяют data.result, при true данные отправлены) и catch (в нём логируют ошибку).
Как проверить результат
- По объекту Promise, который возвращает вызов bridge.send.
- По событиям VKWebAppTrackEventResult и VKWebAppTrackEventFailed.
VKWebAppTrackEventResult сообщает, что данные отправлены: в обработчик приходит объект, где в detail указан type VKWebAppTrackEventResult и data с result true. Он устроен так же, как успешный ответ Promise. VKWebAppTrackEventFailed сообщает об ошибке при взаимодействии с платформой: в обработчик приходит объект с информацией об ошибке, общий для всех методов VK Bridge. Образец обработки событий-результатов и описание ошибок вынесены в общий раздел документации VK Bridge.
Важно знать
- Тип event_name — произвольная строка, а таблица значений озаглавлена как «имеющиеся». Будут ли учтены собственные названия в кабинете, справка не говорит.
- В справке не нашли: как событие появляется в кабинете VK Рекламы, где его смотреть, какая задержка, как привязать событие к цели кампании, лимиты на число вызовов.
- В примере кода закрывающие скобки при вызове bridge.send записаны с лишней парой, поэтому пример копировать нельзя: за образцом идут в документацию VK Bridge.
- Если инструмент не подключён по запросу, что происходит с отправляемыми событиями, справка не уточняет.