Javascript SDK

Renta Javascript SDK — позволяет организовать сбор данных c веб-сайта. SDK обеспечивает потоковую передачу данных в следующие пункты назначения: 

  • Snowflake
  • Google BigQuery
  • Clickhouse
  • Facebook Conversions API
  • Webhooks

Преимущество данного источника данных заключается в поддержке server-side интеграции, что обеспечивает сбор данных от имени первой стороны (1st party data)

Весь процесс настройки сбора данных можно разделить на несколько простых шагов: 

  1. Создание проекта
  2. Создание пользовательского домена.
    Необходимо только для server-side имплементации. 
  3. Внедрение отслеживания событий.  

Создание проекта

Чтобы создать новый источник данных в Каталоге интеграций выберите Javascript.

 

Затем укажите следующие настройки: 

Site URL

Укажите URL сайта для которого необходимо настроить отслеживание. 

Server-side implementation

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

Для этого включите server-side implementation и укажите следующие настройки: 

Custom domain

В поле Custom domain введите поддомен вашего веб-сайта от имени которого будет происходить трекинг. Например, collect.yourdomain.com

IP address

Скопируйте IP address выделенного сервера для вашего проекта и укажите его в качестве A-записи для указанного поддомена. Если настройку вы выполняете не самостоятельно, то воспользуйтесь инструкцией для IT-департамента.

Installing Code

Скопируйте полученный код в поле Installing Code и установите на все страницы сайта. Например, при помощи Google Tag Manager.

Теперь вы можете перейти к настройки событий на стороне сайта. 

Настройка отслеживания событий

При помощи Javascript SDK вы можете настроить 4 типа событий: 

Тип события Описание
page Фиксирует информацию о просмотре страниц. 
track Обеспечивает задачи отслеживания пользовательских действий. Например, для отслеживания транзакций или подписки на рассылку. 
identity  Рекомендуется использоваться только для сбора персональных данных пользователей. Используется для построение профиля пользователя.
group Событие используется для отслеживания группы пользователей. 

Page

Это базовое событие, которое отправляет информацию о просмотре страницы. Данное событие рекомендуется вызывать на всех страницах сайта.

Чтобы вызвать событие просмотра страницы используйте код ниже: 

<script> 
 analytics.page()
</script> 

Вы также можете указать дополнительные атрибуты, если стандартных данных недостаточно. Как модифицировать событие типа page читайте в данном руководстве. 

Track

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

Ниже приведены сценарии использования данного типа события: 

  • Регистрация в продукте
  • Подписка на рассылку
  • Совершение транзакции в интернет-магазине

То есть, вы можете создавать любые события, которые является ценными для вашего проекта. 

Пример вызова javascript-кода для фиксации транзакции: 

<script>
  analytics.track('Transaction completed', {
  transactionId: "ABC00001",
  transactionRevenue: 1000
});
</script>

Каждое событие track состоит из: 

Название поля Обязательный Описание поля
Event name Название события. Например, Transaction completed. 
Properties

Это любая дополнительная информация, которую вы можете отправить вместе с событием.

Вы можете указать любое количество дополнительных атрибутов.

В качестве примера, для события Transaction completed передаются переменные transactionId и transactionRevenue, которые описывают номер и сумму заказа. Данные переменные являются дополнительными атрибутами события. Вы можете удалить их, переименовать или указать собственные атрибуты. 

Identity

Необходимо использовать только в момент идентификации пользователя. Ниже приведены сценарии, когда стоит вызывать данный тип события: 

  • После успешной регистрации
  • После успешной авторизации
  • Когда пользователь обновил свою контактную информацию

Для вызова события используйте javascript-код: 

<script>
 analytics.identify("userid_variable", {
  name: "Elon Musk",
  email: "elon@tesla.com",
  company: "Tesla Motors"
 });
</script>

Помимо стандартных полей, identity поддерживает следующие поля:

Название поля Обязательный Описание поля
userId Уникальный идентификатор пользователя в вашей базе данных.
Properties

Это любая дополнительная информация, которую вы можете отправить вместе с событием.

 

Вы можете указать любое количество дополнительных атрибутов.

 

В качестве примера, javascript-код содержит переменные name, email, company. Данные переменные являются дополнительными атрибутами события. Вы можете удалить их, переименовать или указать собственные атрибуты. 

Group

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

В качестве группы может служить название компании, департамента или проект. То есть, можно использовать любой внутренний идентификатор в вашей системе. 

Для вызова события используйте javascript-код: 

<script>
 analytics.group("groupid_variable", {
  company: "Tesla",
  industry: "Auto Manufacturing",
  employees: 70757
 });
</script>

Помимо стандартных полей, group поддерживает следующие поля:

Название поля Обязательный Описание поля
groupId Уникальный идентификатор группы в вашей базе данных.
Properties

Это любая дополнительная информация, которую вы можете отправить вместе с событием.

 

Вы можете указать любое количество дополнительных атрибутов.

 

В качестве примера, javascript-код содержит переменные company, industry, employees. Данные переменные являются дополнительными атрибутами события. Вы можете удалить их, переименовать или указать собственные атрибуты. 

Структура стандартных полей

По-умолчанию события всех типов поступают со стандартным списком полей, которые доступны для передачи в server-side интеграциях, а также сохраняются в отдельную таблицу при интеграции DWH. 

Перечь стандартных полей, а также их описание доступно ниже в таблице: 

Название поля Тип данных Описание
dateTime datetime Дата и время события по UTC
date date Дата события по UTC
sendAt datetime Дата и время отправки события с клиентской стороны
eventId String Уникальный ID события
eventType String Тип события
eventName String Имя события
properties String Json объект, который содержит пользовательские атрибуты события
anonymousId String Уникальные значение cookie
userId String Номер userId. Содержит значение передаваемое в Google Analytics.
groupId String Уникальные значение группы (доступно только для события типа group)
content String Содержание utm_content
medium String Содержание utm_medium
source String Содержание utm_source
term String Содержание utm_term
campaign String Содержание utm_campaign
dataSource String Источник данных для обращения. По умолчанию обращения от analytics.js будут иметь значение web, а обращения от мобильных SDK – значение app.
device String Тип устройства: desktop, tablet, mobile, TV. 
deviceBrowser String Браузер (например, Chrome или Firefox).
deviceBrowserVersion String Версия браузера.
deviceOperatingSystem String Операционная система (например, Macintosh или Windows).
deviceOperatingSystemVersion String Версия операционной системы. 
deviceIp String IP-адрес
country String Страна
city String Город
region String Регион
deviceUserAgent String User Agent
deviceScreenHeight Int Расширение экрана пользователя в пикселях по высоте
deviceScreenWidth Int Расширение экрана пользователя в пикселях по ширине
deviceViewPortHeight Int Размер области просмотра в браузере по высоте
deviceViewPortWidth Int Размер области просмотра в браузере по ширине
deviceDocEncoding String Кодировка. Например, UTF-8.
location String URL с учетом дополнительных параметров. Например: https://site.com/catalog/platya?page=2
hostname String

Домен. 

Например: https://site.com/

path String

Путь URL страницы. 

Например: /catalog/platya

title String Title страницы.
page String

Полный путь URL. 

Например: https://site.com/catalog/platya

documentReferrer String Если поле medium имеет значение referral, здесь указывается путь источника трафика, а имя хоста содержится в поле source.
fbclid String Идентификатор клика Facebook Ads, который передается в URL при клике по объявлению.
gclid String Идентификатор клика Google Ads, который передается в URL при клике по объявлению.
ydclid String Идентификатор клика Yandex Direct, который передается в URL при клике по объявлению.
ga_cookie_id String Уникальное значение файлов cookie Google Analytics
ym_cookie_id String Уникальное значение файлов cookie Яндекс.Метрики
fbc_cookie_id String Уникальное значение файлов cookie Facebook
fbp_cookie_id String Уникальное значение файлов cookie Facebook
offset String Служебный параметр Javascript SDK. Используется для подсчёта сессий (таблица сессий доступна только в интеграции с DWH)