VKWebAppConversionHit

VKWebAppConversionHit отслеживает конверсионные действия пользователей в мини-приложении. Под отслеживанием понимается, что событие конверсионного действия зарегистрировано в рекламном кабинете.

Пример

JavaScript

bridge.send('VKWebAppConversionHit', {
  pixel_code: 'VK-Boo-427253-dUuM', 
  conversion_event: 'purchase',
  conversion_value: 3500
  })
  .then((data) => { 
    if (data.result) {
      // Конверсионное действие отслежено
    }
  })
  .catch((error) => {
    // Ошибка
    console.log(error);
  });

Платформы

Android, iOS, Mobile Web, Web

Параметры

Поле	Тип	Описание
`pixel_code` обязательное	`string`	Код пикселя. Например: `VK-Boo-427253-dUuM`. Код пикселя можно найти в рекламном кабинете.
`conversion_event` обязательное	`string`	Конверсионное действие, которое необходимо отслеживать. См. возможные значения.
`conversion_value` обязательное	`float`	Стоимость (ценность) конверсионного события (если есть). Например, если пользователь купил товар за 3500 рублей, значение `conversion_event` должно быть `purchase`, а значение `conversion_value` — `3500`.

Примечание. При создании пикселя в рекламном кабинете можно указывать только идентификатор мини-приложения (поле Разрешённый Mini App id). Указывать домен или поддомен необязательно.

Возможные значения конверсионных действий

Внешние и мобильные приложения

•
add_to_cart — добавление товара в корзину.
•
add_to_wishlist — добавление товара в список желаний.
•
customize_product — уточнение сведений о товаре.
•
initiate_checkout — начало оформления заказа.
•
add_payment_info — добавление платёжной информации в процессе оформления заказа. Пример: сохранение данных банковской карты.
•
purchase — совершение покупки или завершение оформления заказа.
•
contact — пользователь совершил действие, чтобы связаться с вами. Примеры: пользователь открыл чат, просмотрел страницу с вашими контактами, отправил свои контактные данные для обратного звонка.
•
lead — получение данных о потенциальном клиенте, контактной информации о покупателе. Пример: заполненная заявка.
•
schedule — запись на приём в одном из ваших магазинов или офисов на определённое время или дату.
•
complete_registration — регистрация, заполнение регистрационной формы.
•
submit_application — подача заявки на предлагаемый вами товар, услугу или программу.
•
start_trial — начало использования бесплатной или пробной версии предлагаемого товара или услуги.
•
subscribe — оформление подписки на товар или услугу.
•
page_view — просмотр страницы. Вы можете прописать это событие на любой важной странице сайта.
•
view_content — просмотр определённого контента. Пример: вы можете вызывать это событие для пользователей, досмотревших страницу до конца.
•
search — использование поиска. Примеры: использование поиска по статьям или товарам на сайте.
•
find_location — поиск местонахождения вашей компании. Пример: открытие карты с филиалами компании.
•
donate — пожертвование средств.
•
conversion — конверсия или целевое действия без уточнения подробностей. Используйте этот тип события, если в списке событий выше вы не нашли подходящее целевое действие.

Результат

Проверить результат можно:

•

Используя объект Promise, который возвращается вызовом bridge.send(...).
•

С помощью событий VKWebAppConversionHitResult и VKWebAppConversionHitFailed.

Подробнее о проверке результатов при вызовах VK Bridge.

Объект `Promise`

Если обращение к платформе прошло успешно, управление будет передано в then-обработчик объекта Promise. В качестве ответа платформа возвращает объект со следующим полем:

Поле	Тип	Описание
`result`	`boolean`	`true`, если конверсионное действие было отслежено.

Если при обращении к платформе произошла ошибка, управление передаётся в метод catch. В качестве ответа платформа возвращает объект с информацией об ошибке, общий для всех событий VK Bridge.

События

`VKWebAppConversionHitResult`

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

JavaScript

{
  detail: {
    type: "VKWebAppConversionHitResult",
    data: {
      result: true
    }
  }
}

Передаваемый объект подобен объекту, возвращаемому при успешном выполнении промиса.

`VKWebAppConversionHitFailed`

Информирует об ошибке, которая произошла при взаимодействии с платформой.

В обработчик события на стороне пользователя передаётся объект с информацией об ошибке, общий для всех методов VK Bridge.

Пример обработки событий

Подробнее — в разделе Обработка результата.