JavaScript API
Содержание
Установка библиотеки
Для установки библиотеки, просто вставьте следующий код в <head> секцию вашей HTML страницы. Не забудьте заменить PIXEL_ID на ваш действующий идентификатор пикселя, который вы получили при регистрации в Hybrid.
<script>
window._txq = window._txq || [];
var s = document.createElement('script'); s.type = 'text/javascript'; s.async = true; s.src = '//st.targetix.net/txsp.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(s);
_txq.push(['createPixel', 'PIXEL_ID']);
</script>
Этот код создаёт глобальную переменную “_txq”, с помощью которой вы сможете отправлять данные в Hybrid API. Библиотека и все запросы будут загружены и выполнены асинхронно, установка кода никаким образом не замедлит скорость работы вашего сайта.
Идентификация посетителя
Для идентификации посетителя вызовите следующий JavaScript из нужного места на Web странице:
<script>
_txq.push(['identify', 'CUSTOMER_ID', IDENTIFY_CONTENT, USER_CONTENT ]);
</script>
| Название поля | Тип | Описание |
|---|---|---|
| CUSTOMER_ID* | string | Уникальный клиентский идентификатор, задаваемый самим сайтом. |
| IDENTIFY_CONTENT | object | Идентификаторы посетителя, в соц. сетях, мобильных приложениях или любые другие идентификаторы. |
| USER_CONTENT | object | Данные о посетителе. |
- - Обязательное поле
Пример
<script>
_txq.push(['identify', 'ab938f', { 'vkid': '123', 'okid': '456' }, { 'age': 30, 'gender': 'man' }]);
</script>
Здесь в IDENTIFY_CONTENT передаётся объект { 'vkid': '123', 'okid': '456' }
Названия ключей для социальных сетей и мобильных платформ предопределены:
| Вконтакте | vkid |
| Одноклассники | okid |
| fbid | |
| Android | adid |
| Ios |
В USER_CONTENT передаётся объект { 'age': 30, 'gender': 'man' }.
Названия ключей произвольны, от типа значения зависят возможные условия для сбора аудитории.
| Num | Равно |
| Не равно | |
| Больше | |
| Больше или равно | |
| Меньше | |
| Меньше или равно | |
| String | Равно |
| Не равно | |
| Начинается с | |
| Заканчивается на | |
| Date | Равно |
| Не равно | |
| Позже | |
| Позже или равно | |
| Раньше | |
| Раньше или равно | |
| Bool | Равно |
| Не равно |
Регистрация событий
Для отслеживания события вызовите следующий JavaScript из нужного места на Web странице:
<script> _txq.push(['track', 'EVENT_NAME', PROPERTIES]); </script>
| Название поля | Тип | Описание |
|---|---|---|
| EVENT_NAME* | string | Имя события. |
| PROPERTIES | object | Набор свойст события. |
- - Обязательное поле
Регистрация просмотра страницы
<script>
_txq.push(['track', 'PageView']);
</script>
Регистрации просмотра товара магазина
<script>
_txq.push(['track', 'ViewContent', { content_ids:[ '4ff2a', ‘b8491’, ‘cfd01’], product_catalog_id:[ '12' ] }]);
</script>
Имя события ('PageView', 'ViewContent') задаётся произвольно, используется при создании рекламной кампании на людей совершивших определённое действие.
Набор свойств { content_ids:[ '4ff2a', 'b8491', 'cfd01'], product_catalog_id:[ '12' ] } задаётся для создания рекламной кампании нацеленной на пользователей, совершивших целевое действие с определённым объектом. Например просмотр товаров [ '4ff2a', 'b8491', 'cfd01'] или каталога [ '12' ]