Рекомендации по разметке своего сервиса
Для корректной работы clickstream, предсказуемого построения графиков а также комфортной работы специалистов по анализу данных рекомендуется разметить свой ресурс достаточно подробно, присваивая событиям осознанные названия.
Разметка сайта представляет собой вызов метода push , при наступлении интересующих событий, с определенными под каждую ситуацию атрибутами.
1. Атрибуты
Для описания значимого, с точки зрения бизнеса, события используются атрибуты. Атрибуты разделены на 2 категории - обязательные и дополнительные.
1.1. Обязательный атрибут: eventAction
Название атрибута: eventAction
Тип: string 1024* (Ограничение количества символов в строке — 1024)
Значение: Название процессаНазвание разделаНазвание экрана + Название элемента Веб-серфингподборкисериалы или surf_collection_serials
Пример: «Аутентификация», «Поиск», «Покупка», «Auth», «Surf», «Search» и тому подобное. Если раздел отсутствует, то в значении можно его не указывать.
Рекомендации по применению:
В названии процесса, раздела и экрана используйте наименования своих процессов, разделов и экранов сайта.
Допустимо использование как русского, так и английского языков.
Для разделения слов в названиях можно использовать нижний пробел «_» или косую черту (slash) «/».
1.2. Дополнительный атрибут: eventCategory
Название атрибута: eventCategory
Тип: string 255 (Ограничение количества символов в строке — 255)
Значение:
Одна из пяти категорий!
(1) Вход/Login,
(2) Показ/Show,
(3) Поиск/Search,
(4) Оформление/Order,
(5) Целевое действие/Goal
Рекомендации по применению:
Используйте атрибут для разметки только тех действий, которые соответствует пяти перечисленным категориям
1.3. Дополнительный атрибут: eventType
Название атрибута: eventType
Тип: string 255 (Ограничение количества символов в строке — 255)
Значение: действие
Пример: Клик, Левый/Правый Свайп, Переключение «ВКЛ»/«ВЫКЛ», Ввод, Удаление, Копирование, Вставка, Ошибка, Лайк, Поделиться, Комментарий
Пример: Click, Left or Right Swipe, Toggle ON/OFF, Input, Delete, Copy, Paste, Error, Like, Share, Comment
1.4. Дополнительный атрибут: value
Название атрибута: value
Тип: string 255 (Ограничение количества символов в строке — 255)
Значение: значение Поля или События
Пример: 100, Иванов, Выставление рейтинга «3 звезды»
1.5. Дополнительный атрибут: tags
Название атрибута: tags
Тип: Array\<string> (Массив из строк-тегов, не более 255 символов каждый)
Значение: ключевое слово (метка)
Пример: Игра Престолов, драма, драконы, Кхалиси, fantasy, serials
1.6. Дополнительный атрибут: properties
Название атрибута: properties
Тип: Record\<string, string> (js объект со значениями типа string)
Значение: свойства события
Пример: Код ошибки, тип аутентификации, версия приложения, цвет кнопки, время ввода запроса и тому подобное
2. Примеры разметки сайтов Партнеров
| Разметка DomClick.ru |
|---|
| Название бизнес-события: Событие 1. Аутентификация по номеру телефона |
| eventCategory: Login |
| eventAction: Auth_Main screen |
| eventType: Click |
| properties: auth type: telephone number / sberId |
| Разметка страниц DomClick.ru |
|---|
| Название бизнес-события: Событие 2. Нажатие на кнопку «Услуги» с любого экрана |
| eventCategory: Show |
| eventAction: surf_services |
| eventType: Click |
| Название бизнес-события: Событие 3. Загрузка страницы «Услуги» |
| eventCategory: Показ |
| eventAction: surf_services |
| eventType: Show |
2.1. Примеры особого случая разметки
У сервиса SberId метрики отправляются через общий скрипт формирования параметров. Ниже пример разметки атрибутов в html и js на страницах SberId:
Разметка:
data-track-event= "oidc/Стараница входа/Вход по QR-коду_Клик"
data-track-event= "oidc/Биометрия/Ошибки/Таймаут по времени"
Код счетчика:
yaCounterXXXXXXXX.reachGoal('oidc\_-\_stranica_vhoda\_-\_vhod_po_qr-kodu_klik', {
'SBOL_WEB': {
'oidc': {
'Стараница входа': 'Вход по QR-коду_Клик'
}
}
});
yaCounterXXXXXXXX.reachGoal ('oidc\_-\_biometriya\_-\_oshibki\_-\_tajmaut_po_vremeni', {
'SBOL_WEB': {
'oidc': { 'Биометрия': {
'Ошибки': 'Таймаут по времени'
}
}
}
} });
В подобном случае рекомендуем размечать два события следующим образом:  | Название бизнес-события - Событие 1 eventCategory: Login eventAction: oidc/Стараница входа/Вход по QR-коду eventType: Click Название бизнес-события - Событие 2 eventCategory: Login eventAction: oidc/Биометрия/Ошибки/Таймаут по времени eventType: error |