Партнерская сеть / Трекинговая аналитика

Трекинговая аналитика

Как это работает

Трекинговая аналитика позволяет собирать и агрегировать события, генерируемые пользователем, для оценки эффективности программы и количества рефералов. Полученные данные используются в качестве дополнительного способа привлечения аффилированных сетей — наличие статистики повышает вероятность взятия программы.

Поддерживается обработка следующих типов событий:

  • переход на сайт;
  • переход в магазин с сайта.

Как настроить

Для интеграции трекинговой аналитики:

  1. Получите JSON Web Token (JWT).
  2. Сохраните tracking_id из параметра запроса в cookie вашего сайта. Пример запроса с tracking_id: https://playnewz.com?utm_source=n6LI9yVu&utm_campaign=5b9bff5f9d31b&tracking_id=19e2DLjNTk2YOdXA4d8J3NReNkXNafhC.
  3. После создания нового пользователя отправьте user_id и tracking_id с помощью метода Отправка события регистрации.
    • Рекомендуется использовать асинхронную отправку запросов, это позволит не прерывать регистрацию новых пользователей на время ожидания ответа Xsolla Tracking API.
    • Вы также можете использовать timeout вместо асинхронной отправки запросов. Обратите внимание, что Иксолла не сможет отследить новых пользователей, если ожидание ответа Xsolla Tracking API превысит заданные временные рамки.
  4. Для создания и управления кастомными событиями добавьте следующие методы Tracking API: создание, инициализация и отправка событий.
  5. Добавьте трекинговый скрипт на ваш сайт.

Получение токена

HTTP-ЗАПРОС

Copy
Full screen
Small screen
POST https://tracking-api.xsolla.com/v1/tokens

ЗаголовокОписание
ContentTypeapplication/json
AuthorizationBasic your_authorization_basic_key. Обязательный.
your_authorization_basic_key — это пара параметров merchant_id:api_key, закодированная по стандарту Base64. Значения merchant_id и api_key вы можете найти в Личном кабинете:
  • merchant_id: Настройки компании > Компания > ID продавца
  • api_key: Настройки компании > Ключи API
ПараметрОписание
sourceTypeНазвание источника данных. Может принимать следующие значения:
  • client. Является недоверенным источником, все события в хранилище будут помечены свойством trusted: false.
  • server. Является доверенным источником, все события в хранилище будут помечены свойством trusted: true.
sourceNameНазвание источника данных.
projectIdID проекта.

ПРИМЕР

Copy
Full screen
Small screen
POST https://tracking-api.xsolla.com/v1/tokens

Headers:
Content-Type: application/json
Authorization: Basic 12kj3hlk1j2hlkjhlk1j2h3lkj 

Body:
{
  "sourceType": "client",
  "sourceName": "landing",
  "projectId": 1
}

HTTP/1.1 201 Token created
{
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsaW5rIjoiaHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2 g_dj1kUXc0dzlXZ1hjUSJ9.aVigY6UVY3jgoEKoBv31cZnROL3I6WKtcr5K-Z7B1du"
}

Код ответаОписание
201Токен успешно создан
400Query-параметры недействительны
401Ключ проекта недействителен

Отправка события регистрации

Для выполнения команды необходим токен.

HTTP-ЗАПРОС

Copy
Full screen
Small screen
POST https://tracking-api.xsolla.com/v1/events

Во время выполнения метода:

  1. Конечный пользователь переходит по трекинговой ссылке из определенного источника трафика (трансляция инфлюенсера, рекламный сайт и прочее). Переходу присваивается Click ID.
  2. На стороне Proxy page формируется Tracking ID, который передается в параметре на сайт игры.
  3. Пользователь переходит на сайт игры и регистрируется.
  4. Игровой разработчик отправляет событие о регистрации через Tracking API, передавая в параметре Tracking ID и ID пользователя.

ЗаголовокОписание
AuthorizationТокен, полученный по запросу.
ПараметрТипОписание
typeСтроковыйТокен, полученный по запросу.
traitsОбъектИдентификационные данные пользователя:
  • trackingId — Tracking ID пользователя, который Иксолла передает в параметре запроса после редиректа на сайт игры.
  • userId — ID пользователя, переданный при получении токена.
contextОбъектДолжен быть пустым.
propertiesОбъектДолжен быть пустым.

ПРИМЕР

Copy
Full screen
Small screen
POST https://tracking-api.xsolla.com/v1/events

Headers:
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsaW5rIjoiaHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g_d j1kUXc0dzlXZ1hjUSJ9.aVigY6UVY3jgoEKoBv31cZnROL3I6WKtcr5K-Z7B1yU 

Body:
{
  "type": "registration",
  "traits": {
    "trackingId": "19e2DLjNTk2YOdXA4d8J3NReNkXNafhC",
    "userId": "20181126"
  },
  "properties": {
  },
  "context": {
  }
}'

Создание события

Для выполнения команды необходим токен.

HTTP-ЗАПРОС

Copy
Full screen
Small screen
POST https://tracking-api.xsolla.com/v1/events

ЗаголовокОписание
AuthorizationТокен, полученный по запросу.
ПараметрТипОписание
typeСтроковыйТип события.
traitsОбъектИдентификационные данные пользователя: телефон, email, ID в игре и т.д.
contextОбъектКонтекстные данные.
propertiesОбъектСвойства события.
createdAtДатаФормат: RFC 3339 или ISO 8601.

ПРИМЕР СОБЫТИЯ: ПЕРЕХОД НА САЙТ

Copy
Full screen
Small screen
POST https://tracking-api.xsolla.com/v1/events

Headers:
Content-Type: application/json
Authorization: Bearer
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsaW5rIjoiaHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g_d j1kUXc0dzlXZ1hjUSJ9.aVigY6UVY3jgoEKoBv31cZnROL3I6WKtcr5K-Z7B1yU 

Body:
{
  "type": "landing_visit",
  "traits":{
    },
  "properties":{
    },
  "context": {
    "user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36", "user_locale":"ru"
  }
}

ПРИМЕР СОБЫТИЯ: ПЕРЕХОД В ПЛАТЕЖНЫЙ ИНТЕРФЕЙС

Copy
Full screen
Small screen
POST https://tracking-api.xsolla.com/v1/events

Headers:
Content-Type: application/json
Authorization: Bearer
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsaW5rIjoiaHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g_d j1kUXc0dzlXZ1hjUSJ9.aVigY6UVY3jgoEKoBv31cZnROL3I6WKtcr5K-Z7B1yU 

Body:
{
  "type": "buy_btn",
  "traits":{
    },
  "properties":{
    "pkg_type":"bronze"
    },
  "context": {
    "user_agent":"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36", "user_locale":"ru"
  }
}

Код ответаОписание
204Событие успешно добавлено
400Событие недействительно
401Токен недействителен

Инициализация события

Для выполнения команды необходим токен.

Copy
Full screen
Small screen
xnt("init", YOUR_TOKEN);

Отправка события

Copy
Full screen
Small screen
xnt("sendEvent", EVENT_TYPE, EVENT_PROPERTIES);

ПараметрОписание
EVENT_TYPEНазвание события (string). Например, "landing_visit".
EVENT_PROPERTIESСвойства события (JS object).

ПРИМЕР

Copy
Full screen
Small screen
xnt("sendEvent", "landing_visit");
xnt("sendEvent", "buy_btn", { pkg_type: $(this).data('id') });

ПАРАМЕТРЫ СОБЫТИЯ

ПараметрОписание
sourceИсточник события (paystation, landing_page и т.д.).
typeТип события (user_visit, hit и т.д.).
traitsДанные о пользователе (email, user_id, nickname и т.д.).
contextДанные о контексте события (ip, gaClientId и т.д.).
propertiesСвойства самого события (sum, levelup и т.д.).
createdAtВремя события, переданное источником.
timestampВремя получения сообщения системой.

Чтобы дополнить событие параметрами в частях 'context' и 'traits', необходимо воспользоваться следующими методами:

Copy
Full screen
Small screen
xnt("putContext", CONTEXT_OBJECT);
xnt("putTraits", TRAITS_OBJECT);

ПараметрОписание
CONTEXT_OBJECTКонтекст события (JS object).
TRAITS_OBJECTДанные пользователя (JS object).
Note:
'userAgent' и 'userLocale' для Context будут встроены автоматически. Данные, добавленные этими методами, будут объединены с данными события.

Подключение скрипта

Подключите на сайт игры следующий скрипт:

Copy
Full screen
Small screen
<script>
(function(i,s,o,g,r,a,m){i['XsollaNetworkTrackingObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(ar guments)},i[r].l=1*new Date();a=s.createElement(o),m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.inse rtBefore(a,m)})(window,document,'script','https://cdn.xsolla.net/network/xtracking-0.1.js','xnt');
xnt("init", "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJsaW5rIjoiaHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g_ dj1kUXc0dzlXZ1hjUSJ9.aVigY6UVY3jgoEKoBv31cZnROL3I6WKtcr5K-Z7B1du");
xnt("sendEvent", "buy_btn", { pkg_type : "gold" });
</script>