Счетчик Snitch для Web
Установка
Добавить в разметку index.html:
- код счетчика топ;
- код библиотеки @mrgis/snitch-web;
- инициализацию счетчика snitch:
window.snitch = createSnitch(...).
Например:
<!DOCTYPE html>
<html>
<head>
<script>
// код счетчика ТОП Mail.ru
</script>
<script>
// код @mrgis/snitch-web (https://unpkg.com/@mrgis/snitch-web@latest/dist/iife.min.js)
</script>
<script>
// инициализация счетчика snitch:
window.snitch = createSnitch({
topmailruCounterId: 'TOP_COUNTER_ID', // обязательный параметр
initialScreen: { screenType: 'loading' }, // опциональный параметр
userIdResolver: () => authService.getCurrentUserId(), // опциональный параметр
flagApiEndpoint: 'https://flags.com/api/v1/' // опциональный параметр
})
</script>
<!-- ... -->
</head>
<body>
<!-- ... -->
</body>
</html>
⚠️ Важно подключать код непосредственно в код страницы (inline) перед кодом приложения. Можно скопировать код в разметку вручную, но удобнее всего организовать это на этапе сборки проекта, например с помощью webpack-плагина InlineChunkHtmlPlugin
TypeScript
Для использования глобальной переменной snitch через TypeScript вам понадобится декларировать её тип, например:
type SnitchEventPayload = {
[key: string]: string | number
}
type Flag = {
flagKey: string
match: boolean
variant?: string
attachment?: string
}
type FlagEvaluationContext = Record<string, string | number | boolean>
interface Snitch {
(eventName: string, eventPayload?: SnitchEventPayload): void
getFlag(flagKey: string, context?: FlagEvaluationContext): Promise<Flag>
getFlags(flagKeys: string[], context?: FlagEvaluationContext): Promise<Flag[]>
}
declare global {
interface Window {
snitch: Snitch
}
}Трекинг событий
Функция snitch имеет сигнатуру (eventName: string, eventPayload?: { [key: string]: string | number }) => void. Для трекинга события необходимо вызвать функцию snitch передав имя события и опциональные параметры, например:
snitch('startPlayingButtonPress') // пользователь нажал на кнопку «Начать игру»
snitch('characterLevelUp', { characterId: '123', level: 12 }) // пользователь прокачал персонажа с id '123' до 12 уровняТрекинг событий от лица авторизованного пользователя
Способ #1: через параметр userIdResolver
Чтобы события счетчика ассоциировались с авторизованным пользователем, при инициализации счетчика createSnitch можно определить параметр userIdResolver. В параметре передаётся функция с сигнатурой () => string | null | undefined, которая должна возвращать строку вида <ID пользователя>@<провайдер>, например: 12345@vk, если пользователь вошел используя VKID или user@gmail.com, если вошел под почтой и т.д. Если пользователь не авторизован, то функция должна возвращать null или undefined.
Способ #2: через JS API счетчика ТОП Mail.ru
Указывать ID текущего пользователя можно в более императивном стиле, с помощью методов счетчика ТОП Mail.ru:
-
window._tmr.setUserID("<ID пользователя>@<провайдер>")— вызывать, когда пользователь авторизовался на сайте, и при последующих загрузках страниц сайта до вызова инициализации счетчика (createSnitch). -
window._tmr.deleteUserID()— вызывать при логауте пользователя.
Трекинг навигации пользователя по экранам приложения
Чтобы собирать статистику о навигации пользователя внутри приложения вводится понятие экрана. Экран приложения описывается объектом с полем screenType и опциональным полем screenId, например: { screenType: 'onboarding', screenId: 'step1' }
-
screenType: string — указывает на тип экрана, например:'сatalogue','product','cart'. -
screenId: string — позволяет, когда это требуется, уточнить информацию об экране. Например, экран со статьей «Как есть печенье и не толстеть?»screenTypeможет иметь значение'article', аscreenIdзначение'how-to-eat-cokies-and-not-get-fat'— уникальный slug статьи.
Пример разметки экранов приложения
Чтобы настроить трекинг навигации, необходимо:
- В коде инициализации счетчика указать экран, на который попадает пользователь при открытии приложения:
window.snitch = createSnitch({
topmailruCounterId: 'TOP_COUNTER_ID',
initialScreen: { screenType: 'loading' } // <- экран загрузки
})- При показах пользователю нового экрана необходимо отправлять событие
screenChangeс информацией об экране в качестве параметров события, например:
snitch('screenChange', { screenType: 'catalogue' }) // пользователь перешел на экран каталога
snitch('screenChange', { screenType: 'product', screenId: 'wagon-wheels-cookies' }) // пользователь перешел на экран продукта «Печенье Wagon Wheels»
snitch('screenChange', { screenType: 'cart' }) // пользователь перешел в корзинуФлаги
Snitch позволяет работать с feature flags. Для этого при инициализации счетчика в параметре flagApiEndpoint нужно указать URL эндпоинта сервиса флагов. Значения флагов можно получать методом snitch.getFlag или батч методом snitch.getFlags. Ответ будет содержать флаг или массив флагов в виде объекта с полями:
-
flagKey: string— уникальное имя флага -
match: boolean— включен или отключен флаг -
variant: string— вариант, если флаг имеет варианты -
attachment: string— дополнительные данные в формате JSON-строки
Пример использования getFlag:
snitch.getFlag('test-app-button-color').then(console.log){
"flagKey": "test-app-button-color",
"match": true,
"variant": "red",
"attachment": ""
}Пример использования getFlags:
snitch.getFlags(['test-app-button-color', 'test-app-illustration-toggle']).then(console.log)[
{
"flagKey": "test-app-button-color",
"match": true,
"variant": "red",
"attachment": ""
},
{
"flagKey": "test-app-illustration-toggle",
"match": false,
"variant": "",
"attachment": ""
}
]