Использование JavaScript кода и его настройки
После установки скрипта на страницы сайта, у Вас создаются два глобальных обьекта
Объект | Название | Описание |
---|---|---|
window.SPH | Smart Pixel Helper | Объект настроек и инициализации самого JavaScript кода |
window.SPM | Smart Pixel Manager | Интерфейс для работы с пикселем внутри страницы |
Основные настройки Smart Pixel Helper (SPH):
cookieName - название Cookie, в которой будет храниться идентификатор пользователя (по умолчанию - “ssId“)
cookieExpireYears - длительность жизни куки пользовательского идентификатора, записанной в переменную cookieName (по умолчанию 10 лет)
queryParameter - значение GET переменной, в которой храниться идентификатор пользователя
По умолчанию, значение “ssId“, если Вы изменяете данную опцию, опция работы Smart Pixel внутри воронки будет нарушена, и, Вам нужно будет в ручном порядке передавать идентификатор пользователя.
timeout - значение задержки, которая используется для отложенной обработки элементов видео, формы, так как их загрузка асинхронна (по умолчанию, значение 3 секунды). Значение указывается в формате миллисекунд, к примеру, 3 секунды = 3000 миллисекунд.
Не указывайте слишком маленькое значение, так как при низкой задержке, не все элементы могут быть захвачены.
identifier - идентификатор Вашего пикселя для проекта
baseUrl - базовый URL который используется системой для интеграции и передачи данных
Не меняйте данное значение самостоятельно, если интеграция обновиться со стороны Smart Sender, Вам нужно будет изменить данное значение
Основные функции Smart Pixel Manager (SPM):
fire(name, context) - запускает ручное событие по названию c переменными, которые необходимо сохранить в карточку клиента
user.get(): Number|String|Null - возвращает идентификатор пользователя Smart Sender;
user.exists(): Boolean - проверка на существование идентификатора пользователя Smart Sender;
user.set(identifier): void - указание идентификатора пользователя Smart Sender для текущей сессии.
Примеры использования
Инициализация скрипта с custom параметрами
....
window.SPH = {
timeout: 8000, // 8 sec
cookieName: 'smartId',
cookieExpireYears: 1,
identifier: 'SPH-XXXXXX', // enter your Smart Pixel identifiier here
baseUrl: 'https://customer.smartsender.eu/pixel',
};
...
Запуск ручного события “demo“ с пользовательской переменной “name“ и значением “value“
window.SPM.fire('demo', {
name: 'value',
});
Получение идентификатора пользователя
return window.SPM.user.get(); // return '7777'