Після встановлення скрипта на сторінки сайту, у Вас створюються два глобальні об'єкти
Об'єкт | Назва | Опис |
---|---|---|
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) - запускає ручну подію за назвою зі змінними, які необхідно зберегти в картку клієнта
Щоб дані записалися, необхідно щоб було активовано збереження даних з URL для даного тригера.
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'