Payments / Аналитика событий
  На главную

Payments

Аналитика событий

Вы можете использовать эту функцию, если у вас уже подключен продукт Pay Station и настроен хотя бы один сервис аналитики:

Внимание

Google Analytics и Facebook собирают данные, если пользователь разрешил использовать все файлы cookie или выбрал в баннере GDPR разрешение использовать cookie для аналитики и улучшения работы сайта.

Интеграция с сервисами аналитики

Чтобы отслеживать события, связанные с действиями пользователей в платежном интерфейсе, подключите сервисы аналитики в Личном кабинете:

Google Analytics

Для подключения сервиса аналитики:

  1. Откройте ваш проект в Личном кабинете.
  2. Перейдите в раздел Платежи > Настройки.
  3. В разделе Приложения выберите Google Analytics.
  4. Нажмите Подключить.

Когда вы интегрируете Google Analytics, соответствующие события будут отправляться в вашу учетную запись. Информация о событиях хранится в Google Analytics в разделе Behaviour > Events > Top Events.

Вы можете отслеживать следующие события:

ДействиеОписание
open-{state_name}Открытие страницы платежного интерфейса.
click-btn-payНажатие на кнопку Оплатить на форме ввода платежных данных.
returnНажатие на кнопку Вернуться в магазин/Начать заново.
create-invoiceСоздание транзакции.
purchaseСоздание счета на оплату товара (присваивание ID транзакции). В параметрах события содержится детальная информация о покупке, включая стоимость товаров и налоги. Описание параметров события приведено в документации Google Analytics.

Событие отправляется, только если у вас настроен каталог товаров в Личном кабинете в разделе Store.
open-payment-credit-cardОткрытие платежного интерфейса для ввода данных карты.
open-payment-saved-methodsОткрытие страницы с сохраненными способами оплаты.
open-payment-payment-methodsОткрытие списка всех доступных способов оплаты при нажатии Еще.
open-payment-{id}Открытие страницы определенного способа оплаты, где id — ID способа оплаты.
open-statusОткрытие страницы статуса платежа.
open-status-processingОткрытие страницы статуса платежа в статусе обработки (processing). После завершения обработки платежа статус может измениться на успешный (success) или ошибку (error).
open-status-errorОткрытие страницы статуса платежа в статусе ошибки (error).
open-status-successОткрытие страницы статуса платежа в успешном статусе (success).
choose-methodВыбор способа оплаты при переходе из списка Еще.
Специальные параметры и показатели Google Analytics
ID показателяНазваниеОписание
1versionВерсия платежного интерфейса.
2purchase_invoice_idID заявки на оплату в системе Xsolla.
3external_idID заявки на оплату в системе партнера.
5total_sumИтоговая сумма покупки с учетом всех комиссий.
6total_sum_currencyВалюта итоговой суммы покупки.
7pidID платежной системы.
8projectIdID проекта.
9countryСтрана платежа.
10projectNameНазвание проекта.

Facebook Analytics

Для подключения сервиса аналитики:

  1. Откройте ваш проект в Личном кабинете.
  2. Перейдите в раздел Платежи > Настройки.
  3. В разделе Приложения выберите Facebook Pixel.
  4. Нажмите Подключить.

Когда вы интегрируете Facebook Pixel, соответствующие события будут отправляться в вашу учетную запись Facebook Analytics. Информация о событиях хранится в Facebook Analytics в разделе Business Settings > Measure & Report > Analytics > Pixels > Overview.

Вы можете отслеживать следующие события:

СобытиеОписание
open-{state_name}Открытие страницы платежного интерфейса. В parameters передается название страницы.
click-btn-payНажатие на кнопку Оплатить на форме ввода платежных данных. В parameters передается название платежного метода.
returnНажатие на кнопку Вернуться в магазин/Начать заново. В parameters передается статус платежа.
change-status-{status_name}Смена статуса платежа.
Если пользователь закрывает страницу или платежный интерфейс и статус меняется после закрытия, сообщение о событии не отправляется.
create-invoiceСоздание транзакции.
open-payment-credit-cardОткрытие платежного интерфейса для ввода данных карты.
open-payment-saved-methodsОткрытие страницы с сохраненными способами оплаты.
open-payment-payment-methodsОткрытие списка всех доступных способов оплаты при нажатии Еще.
open-payment-{id}Открытие страницы определенного способа оплаты, где id — ID способа оплаты.
open-statusОткрытие страницы статуса платежа.
open-status-processingОткрытие страницы статуса платежа в статусе обработки (processing). После завершения обработки платежа статус может измениться на успешный (success) или ошибку (error).
open-status-errorОткрытие страницы статуса платежа в статусе ошибки (error).
open-status-successОткрытие страницы статуса платежа в успешном статусе (success).
choose-methodВыбор способа оплаты при переходе из списка Еще.

Для подключения сервиса аналитики:

  1. Перейдите в Личный кабинет > Pay Station > Настройки.
  2. В разделе Приложения выберите Google Analytics/Facebook Pixel.
  3. Укажите ID сервиса аналитики и нажмите Подключить.

Когда вы интегрируете Google Analytics и Facebook Pixel, соответствующие события будут отправляться в ваши учетные записи Google Analytics и Facebook Analytics.

GameAnalytics

Для подключения сервиса аналитики:
  1. Откройте проект в Личном кабинете.
  2. Перейдите в раздел Pay Station > Настройки.
  3. В разделе Приложения выберите GameAnalytics.
  4. Нажмите Подключить.

  1. В поле Ключ игры GameAnalytics укажите ключ игры. Чтобы найти эти данные в вашем аккаунте в GameAnalytics:
    1. В раскрывающемся меню на верхней панели выберите игру.
    2. В разделе Keys нажмите значок копирования в строке Game key.

Примечание
Если ваша игра опубликована на разных платформах и в GameAnalytics у вас созданы проекты для каждой из них, в Личном кабинете вы можете ввести ключ игры для любой платформы.

  1. Нажмите Подключить.

В настоящее время интеграция с сервисом GameAnalytics позволяет получать информацию о событии успешного платежа. Вы можете найти эти данные в вашем аккаунте в GameAnalytics на дашборде в разделе Monetization.

События платежного интерфейса

События платежного интерфейса обрабатываются с помощью механизма postMessage, если платежный интерфейс открывается в iframe, новом окне или с помощью скрипта Pay Station Embed.

Пример сценария обработки сообщений, отправленных через postMessage:

  1. Подпишитесь на получение сообщений, отправленных через postMessage.
  2. Осуществите парсинг данных по событию в формат JSON.
  3. Реализуйте проверку на наличие события, которое необходимо обработать.
  4. При получении нужного события реализуйте логику его обработки. В примере ниже в консоль выводится текст. Вы можете добавить свою логику.

Пример:
Copy
Full screen
Small screen
    window.addEventListener('message', (event) => {
      const eventData = JSON.parse(event.data);
    
      if (eventData.command === 'open-payment') {
        console.log('hello!')
      }
    });
    
    СобытиеОписание
    add_saved_accountУспешное сохранение платежного аккаунта.
    add_saved_account_errorОшибка при сохранении платежного аккаунта.
    cancel_save_accountОтмена пользователем сохранения платежного аккаунта.
    cart_displayОтображение платежного интерфейса в виде колонок. В параметре value передается:
    • 1, если платежный интерфейс открывается в виде двух колонок;
    • 0, если платежный интерфейс открывается в виде одной колонки, например на странице управления сохраненными платежными методами.
    Пример: {“command”:“cart_display”,“data”:{“value”:“1”,“version”:“Pay Station 4”}}.
    change-statusСмена статуса платежа. Если пользователь закрывает страницу или платежный интерфейс и статус меняется после закрытия, сообщение о событии не отправляется.
    choose-methodВыбор способа оплаты при переходе из списка Еще.
    click-custom-package-continueНажатие на кнопку Далее при покупке произвольного количества виртуальной валюты.
    click-commentНажатие на кнопку для отправки комментария.
    click-buy-packageНажатие на кнопку Купить при покупке пакета виртуальной валюты.
    click-buy-gift-packageНажатие на кнопку при покупке пакета виртуальной валюты в подарок.
    click-buy-gift-custom-packageНажатие на кнопку при покупке произвольного количества виртуальной валюты в подарок.
    click-btn-payНажатие на кнопку Оплатить на форме ввода платежных данных.
    click-btn-continueНажатие на кнопку покупки подписки.
    click-btn-applyНажатие на кнопку Далее при погашении купона.
    click-btn-activateНажатие на кнопку Активировать при активации ключа.
    click-btn-acceptНажатие на кнопку покупки цифрового контента.
    create-invoiceСоздание транзакции.
    dimensionsОткрытие платежного интерфейса в iframe. В параметрах width и height передается ширина и высота iframe.
    errorВозникновение ошибки во время совершения платежа. В параметре data.code передается код ошибки, в параметре data.message — описание ошибки, которое также отображается в платежном интерфейсе пользователю.
    external-link-openПереход на внешний ресурс. В параметре url передается адрес, по которому происходит переход.
    external-payment-openПереход из платежного интерфейса на внешнюю платежную систему или верификацию 3-D Secure.
    focus-changeИзменение фокуса на элементах виджета платежного интерфейса. Состояние фокуса передается в параметре hasFocus, может принимать значение true или false.
    open-{state_name}Открытие страницы платежного интерфейса.
    open-payment-credit-cardОткрытие платежного интерфейса для ввода данных карты.
    open-payment-saved-methodsОткрытие страницы с сохраненными способами оплаты.
    open-payment-payment-methodsОткрытие списка всех доступных способов оплаты при нажатии Еще.
    open-payment-{id}Открытие страницы определенного способа оплаты, где id — ID способа оплаты.
    open-statusОткрытие страницы статуса платежа.
    open-status-processingОткрытие страницы статуса платежа в статусе обработки (processing). После завершения обработки платежа статус может измениться на успешный (success) или ошибку (error).
    open-status-errorОткрытие страницы статуса платежа в статусе ошибки (error).
    open-status-successОткрытие страницы статуса платежа в успешном статусе (success).
    order-statusИзменение статуса заказа на done. Отправляется со страницы статуса платежа, если заказ был создан через один из следующих методов API:
    В объекте data передаются данные о пользователе, транзакции и заказе.

    Пример: {“command”:“order-status”,“data”:{“user_id”:“123abc-456”,“invoice_id”:123456,“price”:{“amount”:“12.96”,“currency”:“USD”},“order_id”:123456,“items”:[{“id”:123456,“sku”:“booster_min”,“quantity”:2,“amount”:“3.99”,“price”:{“amount”:“3.99”,“currency”:“USD”},“tax_category”:“DG00001”},{“id”:123456,“sku”:“boots_1”,“quantity”:1,“amount”:“2.99”,“price”:{“amount”:“2.99”,“currency”:“USD”},“tax_category”:“DG00001”},{“id”:1234567,“sku”:“xsolla_gloves”,“quantity”:1,“amount”:“1.99”,“price”:{“amount”:“1.99”,“currency”:“USD”},“tax_category”:“DG00001”},{“id”:12345678,“sku”:“reward_vp_a”,“quantity”:5,“amount”:“0”,“price”:{“amount”:“0”,“currency”:“USD”},“tax_category”:“DG00001”}],“version”:“Pay Station 4”}}.
    resizeИзменение размера платежного интерфейса. В объекте data передаются ширина и высота открытого платежного интерфейса.
    Пример: {“command”:“resize”,“data”:{“dimensions”:{“width”:924,“height”:754},“version”:“Pay Station 4”}}.
    show-error-pageПереход пользователя на страницу с ошибкой. В параметре value передается код ошибки.
    statusПереход на страницу статуса платежа. Могут передаваться следующие параметры:
    • status — статус платежа;
    • email — email-адрес пользователя;
    • invoice — ID транзакции;
    • virtualCurrencyAmount — количество приобретенной виртуальной валюты;
    • userId — ID пользователя;
    • discount — примененная к платежу скидка.
    status-redeemПогашение купона на платежной форме.
    closeЗакрытие платежного интерфейса.
    В каждом сообщении от postMessage передаются параметры события. Если информация по параметру еще не собрана, придет пустая строка.
    ПараметрТипОписание
    actionstringИмя события.
    valuestringДополнительный параметр, содержит специфические параметры события, которые меняются в зависимости от выбора пользователя.
    statestringСтраница платежного интерфейса, на которой совершено действие.
    datestringДата и время в формате GMT.
    millisecondsnumberДата и время в формате Unix time.
    timezonestringЧасовой пояс пользователя.
    session_idstringID сессии. К сессии относятся действия пользователя на протяжении 30 минут или до момента закрытия платежного интерфейса. Сессия начинается с момента открытия платежного интерфейса и сохраняется при перезагрузке страницы, на которой открыт платежный интерфейс.
    payment_countrystringСтрана платежа.
    purchase_invoice_idnumberID заявки на оплату в системе Xsolla.
    purchase_external_idstringID заявки на оплату в системе партнера.
    purchase_typestringТип покупки. Может принимать значение: virtual item, virtual currency, pay2play, subscription.
    purchase_sumnumberНоминальная сумма покупки.
    purchase_currencystringВалюта покупки.
    purchase_skustringАртикул товара в покупке.
    purchase_digital_content_skustringАртикул пакета игровых ключей в покупке.
    purchase_descriptionstringОписание покупки.
    virtual_currency_amountnumberКоличество виртуальной валюты.
    coupon_codestringКод купона.
    subscription_package_external_idnumberID подписки.
    subscription_package_namestringID подписки.
    subscription_package_descriptionstringОписание подписки.
    total_sumnumberИтоговая сумма покупки с учетом всех комиссий.
    total_sum_currencystringВалюта итоговой суммы покупки.
    user_idstringID пользователя (v1).
    user_countrystringСтрана пользователя.
    payment_instance_namestringНазвание способа оплаты.
    События привязаны к страницам, на которых пользователь совершает действия при покупке.
    ШагОписание
    cartСтраница с выбранным товаром и подтверждением покупки за виртуальную валюту.
    couponФорма для ввода купона.
    giftcardСтраница со списком подарочных карт (виджет Подарочные карты).
    giftrecipientСтраница покупки товара в подарок.
    historyСтраница с историей покупок.
    indexСлужебная страница, на которую происходит переход при открытии приложения. Не отображается пользователю.
    legalМобильная версия страницы со ссылками на юридические документы.
    listСписок способов оплаты.
    paybycashСтраница с выбором способа оплаты через терминалы (виджет Оплата наличными).
    paymentПлатежная форма.
    paymentaccountСтраница с сохраненными платежными аккаунтами.
    paymentreturnСлужебная страница, на которую происходит переход после оплаты в платежной системе, и с которой происходит дальнейший переход на страницу статуса. Не отображается пользователю.
    pincartСтраница с выбором платформы для покупки цифрового контента.
    pricepointМагазин с виртуальной валютой.
    savedmethodСписок сохраненных способов оплаты.
    shippingaddressФорма заполнения адреса доставки.
    statusСтраница статуса.
    subscriptionМагазин с планами подписок.
    subscriptionchangeИзменение плана подписки.
    useraccountСтраница информации об аккаунте (имя пользователя, баланс) с настройкой Отключить шаг подтверждения для будущих покупок.
    userinventoryИнвентарь пользователя.
    usermenuМобильная версия страницы с меню пользователя.
    usersubscriptionУправление подписками пользователя.
    usersubscriptioninfoСтраница с деталями подписки.
    virtualitemМагазин с виртуальными товарами.

    Чтобы отправлять события в ваши учетные записи Google Analytics и Facebook Analytics, необходимо настроить интеграцию с данными сервисами аналитики.
    Была ли статья полезна?
    Спасибо!
    Что может сделать страницу еще лучше? Сообщение
    Жаль, что так произошло
    Расскажите, почему статья не была полезна. Сообщение
    Спасибо за обратную связь!
    Ваши мысли и идеи помогут нам улучшить ваш пользовательский опыт.
    Последнее обновление: 3 октября 2024

    Нашли опечатку или ошибку в тексте? Выделите ее и нажмите Ctrl+Enter.

    Сообщите о проблеме
    Мы постоянно улучшаем качество нашей документации. Ваш отзыв поможет нам в этом.
    Укажите email-адрес, чтобы мы могли связаться с вами
    Спасибо за обратную связь!