JavaScript SDK Roistat¶

При помощи JavaScript SDK вы можете обращаться к объектам счетчика Roistat, установленного на ваших сайтах, и управлять всеми его функциями, включая получение информации о визите, управление Коллтрекингом, Ловцом лидов, Email-трекингом и т.д.

Обратите внимание

Внимательно изучите данную страницу перед тем, как использовать JavaScript SDK. Его неправильное использование может нарушить работу Roistat на вашем сайте. Если у вас останутся вопросы, напишите нам, и мы поможем.

Описание работы JavaScript SDK
Методы объекта window.roistat
Методы объекта window
Колбэки готовности JS SDK

Описание работы JavaScript SDK¶

Счетчик Roistat добавляет на страницу набор объектов и методов, которые позволяют управлять поведением Roistat и добавлять дополнительную логику в работу модулей.

Для правильной работы JavaScript SDK требуется дождаться его загрузки. Для этого существуют колбэки, которые вызываются по готовности JS API.

После загрузки основного модуля на страницу добавляется объект roistat, который содержит набор методов и переменных, отвечающих за работу счетчика и остальных модулей.

Методы объекта `window.roistat`¶

При загрузке счетчик добавляет на страницу объект window.roistat. В нём находятся методы и объекты по управлению всей функциональностью Roistat. По мере загрузки всех модулей, в window.roistat будут становиться доступными соответствующие объекты.

В таблице ниже приведены методы и атрибуты объекта window.roistat.

Метод / атрибут	Возвращаемый тип	Описание
authClientByEmail(email)	void	Присвоить визиту email клиента для объединения цепочки визитов
authClientById(clientId)	void	Присвоить визиту ID клиента для объединения цепочки визитов
callTracking	object	Объект с методами и атрибутами коллтрекинга
disableCallTracking()	void	Отключить Коллтрекинг на странице
emailtracking	object	Объект с методами и атрибутами Email-трекинга
event.send(eventName,[eventFields])	void	Отправляет событие в аналитику
geo	object	Объект с географическими данными клиента
getSource()	string	Получить значение маркера roistat (источника визита)
getVisit()	string	Получить номер визита
leadHunter	object	Объект с методами и атрибутами ловца лидов
multiwidget	object	Объект с методами и атрибутами мультивиджета
onlineChat	object	Объект с методами и атрибутами Онлайн-чата
page.params.roistat_param1..5	string	Объект с параметрами страницы
setRoistatParams	void	Установить дополнительные параметры `roistat_param`
setVisit(visitId)	void	Установить номер визита

Методы объекта `window`¶

Roistat добавляет набор методов и атрибутов в объект window, которые позволяют управлять функциями Roistat на странице.

Метод / атрибут	Возвращаемый тип	Описание
window.roistat.setCallTrackingManualMode()	void	Перевести Коллтрекинг в ручной режим
window.roistatCallTrackingRefresh()	void	Запрашивает номера для коллтрекинга
window.roistatCalltrackingScripts	void	Включает определенные сценарии Коллтрекинга на странице
window.roistatLeadHunterShow()	void	Показывает форму Ловца лидов на странице
window.roistatMetrikaCounterId	string	ID счетчика Яндекс.Метрики, который прописан в интеграции Roistat
window.roistatMultiwidgetShow	void	Вызывает кнопку Мультивиджета
window.roistatOnlineChatToggle()	void	Показывает окно онлайн-чата
window.setRoistatOnlineChatCustomParams()	object	Устанавливает дополнительные параметры чата и передает их в интерфейс операторского приложения
window.roistatPromoCodeRefresh()	void	Обновляет значение промокода Roistat в элементе .roistat-promo
window.registerOnCalltrackingPhoneReceivedCallback	function()	Колбэк, который вызывается после того, как от сервера получены телефоны для отображения на странице

Колбэки готовности JS SDK¶

Колбэки используются для выполнения функций после загрузки модулей счетчика.

Колбэк	Описание
onRoistatModuleLoaded	Колбэк для работы с визитами и включения/выключения дополнительных возможностей
onRoistatAllModulesLoaded	Колбэк для доступа к функциональности дополнительных возможностей – Коллтрекинга, Email-трекинга, А/Б тестов, Событий
onRoistatLeadHunterInited	Вызывается после того, как модули виджета Ловец лидов зарегистрировали свои настройки и методы, с которыми можно взаимодействовать
onRoistatMultiwidgetInited	Вызывается после того, как модули Мультивиджета зарегистрировали свои настройки и методы, с которыми можно взаимодействовать
onRoistatOnlineChatInited	Вызывается после того, как модули виджета Онлайн-чат зарегистрировали свои настройки и методы, с которыми можно взаимодействовать

`onRoistatModuleLoaded`¶

Вызывается после загрузки основного модуля, до загрузки дополнительных модулей инструментов – Коллтрекинга, Email-трекинга, А/Б тестов, Событий.

Используйте этот колбэк, чтобы повлиять на поведение дополнительных инструментов – например, отключить Коллтрекинг или Email-трекинг на странице.

window.onRoistatModuleLoaded = function () {
    window.roistat.emailtracking.enabled = false; // Отключить Email-трекинг
    window.roistat.setCallTrackingManualMode(); // Включить ручной режим для отображения номеров Коллтрекинга
};

Внутри этого колбэка специфичные дейcтвия для инструментов недоступны (т.к. они ещё не загрузились). Для управления возможностями дополнительных инструментов используйте колбэк onRoistatAllModulesLoaded.

`onRoistatAllModulesLoaded`¶

Вызывается после того, как модули инструментов зарегистрировали свои настройки и методы, с которыми можно взаимодействовать.

В этом колбэке доступны все возможности всех инструментов счётчика. После загрузки модулей инструменты начинают выполнять свою работу: отображение телефонов и email-ов, отправку и получение данных аналитики и т.п.

window.onRoistatAllModulesLoaded = function () {
  window.roistat.emailtracking.refresh(); // Обновить адреса Email-трекиннга на странице
};

Колбэки, которые вызываются после onRoistatAllModulesLoaded:

Колбэк	Описание
registerOnCalltrackingPhoneReceivedCallback	Колбэк, который вызывается после того, как от сервера получены телефоны для отображения на странице
registerOnVisitProcessedCallback	Колбэк, который вызывается при работе с визитами — методы getSource(), getVisit(), setRoistatParams()

Примечание

Вызов колбэка onRoistatAllModulesLoaded необязательно означает полную загрузку данных на сайте. Например, сразу после загрузки модуля Коллтрекинга может быть неизвестен номер телефона, так как от сервера еще не получены номера для коллтрекинга на странице. Как только номера получены, вызывается колбэк registerOnCalltrackingPhoneReceivedCallback, и номер передается на сайт.

Отключить или включить инструмент на этом этапе уже поздно – для включения/выключения инструментов используйте колбэк onRoistatModuleLoaded.

Модули виджетов грузятся по отдельным колбэк-функциям:

onRoistatLeadHunterInited – для Ловца лидов.
onRoistatOnlineChatInited – для Онлайн-чата.
onRoistatMultiwidgetInited – для Мультивиджета.

Визиты¶

`getSource()`¶

Возвращает рекламный канал визита. Если маркера нет, то возвращает null.

window.onRoistatAllModulesLoaded = function () {
    window.roistat.registerOnVisitProcessedCallback(function() {
        console.log("Маркер визита: " + window.roistat.getSource());
    });
};

`getVisit()`¶

Возращает номер визита.

window.onRoistatAllModulesLoaded = function () {
    window.roistat.registerOnVisitProcessedCallback(function() {
        console.log("Установлен номер визита: " + window.roistat.getVisit());
    });
};

`page.params.roistat_param1..5`¶

Атрибуты, в которых хранятся значения параметров roistat_param текущего визита.

window.onRoistatModuleLoaded = function () {
    console.log("roistat_param1 = " + window.roistat.roistat_param1);
    console.log("roistat_param2 = " + window.roistat.roistat_param2);
    console.log("roistat_param3 = " + window.roistat.roistat_param3);
    console.log("roistat_param4 = " + window.roistat.roistat_param4);
    console.log("roistat_param5 = " + window.roistat.roistat_param5);
};

`setRoistatParams`¶

Установить дополнительные параметры roistat_param, чтобы затем строить отчеты по ним. Можно установить до 50 параметров в любой последовательности.

window.onRoistatAllModulesLoaded = function () {
    window.roistat.registerOnVisitProcessedCallback(function () {
        window.roistat.setRoistatParams({
            'roistat_param1': 'значение',
            'roistat_param23': 'значение',
            'roistat_param26': 'значение',
            'roistat_param31': 'значение',
            'roistat_param41': 'значение'
        });
    });
};

Например, нужно присвоить визиту три дополнительных параметра:

День недели: roistat_param1 = Monday
Пол клиента: roistat_param2 = female
Возраст клиента: roistat_param3 = 27

Тогда запрос будет выглядеть следующим образом:

window.onRoistatAllModulesLoaded = function () {
    window.roistat.registerOnVisitProcessedCallback(function () {
        window.roistat.setRoistatParams({
            'roistat_param1': 'Monday',
            'roistat_param2': 'female',
            'roistat_param3': '27'
        });
    });
};

Обратите внимание

Измененные данные появятся в проекте при следующем обновлении данных аналитики.

Также доступен другой вариант скрипта, в котором можно установить значения 5 параметров roistat_param:

window.onRoistatAllModulesLoaded = function () {
  window.roistat.registerOnVisitProcessedCallback(function () {
    window.roistat.setRoistatParams(param1, param2, param3, param4, param5);
  });
};

Можно пропустить любой из параметров, используя null:

window.onRoistatAllModulesLoaded = function () {
  window.roistat.registerOnVisitProcessedCallback(function () {
    window.roistat.setRoistatParams(Monday, female, null, null, 27);
  });
};

`setVisit(visitId)`¶

Вручную задать номер визита.

window.onRoistatModuleLoaded = function () {
    window.roistat.setVisit(123456);
};

Email-трекинг¶

`emailtracking`¶

Объект с методами и атрибутами Email-трекинга.

Метод / атрибут	Возвращаемый тип	Описание
emails	object	Массив с соответсвиями адресов Email-трекинга
enabled	boolean	Флаг, определяющий, включен ли Email-трекинг
loaded	boolean	Флаг, определяющий, был ли загружены email-ы с серверва
refresh()	void	Обновить адреса Email-трекинга на странице

`emails`¶

Объект с соответствиями адресов Email-трекинга.

window.onRoistatAllModulesLoaded = function () {
    console.log("Адреса Email-трекинга: " + JSON.stringify(window.roistat.emailtracking.emails));
};

Пример возвращаемого объекта:

{
  "email_to_replace1@mail.com": "email_to_replace_with1@mail.com",
  "email_to_replace2@mail.com": "email_to_replace_with2@mail.com"
}

`enabled`¶

Флаг, определяющий, включен ли Email-трекинг.

window.onRoistatAllModulesLoaded = function () {
  console.log("Email-трекинг включен: " + window.roistat.emailtracking.enabled);
};

Чтобы выключить Email-трекинг на странице, нужно установить значение до загрузки модуля Email-трекинга:

window.onRoistatModuleLoaded = function() {
  window.roistat.emailtracking.enabled = false;
}

`loaded`¶

Флаг, определяющий, загружены ли адреса Email-трекинга с сервера.

window.onRoistatAllModulesLoaded = function () {
  console.log("Адреса Email-трекинга загружены с сервера: " + window.roistat.emailtracking.loaded);
};

`refresh()`¶

Обновить адреса Email-трекиннга на странице.

window.onRoistatAllModulesLoaded = function () {
  window.roistat.emailtracking.refresh();
};

Интеграции¶

`window.roistatMetrikaCounterId`¶

ID счетчика Яндекс.Метрики, который прописан в интеграции Roistat.

window.onRoistatModuleLoaded = function () {
   console.log("ID cчетчика Метрики из интеграции Roistat: " + window.roistatMetrikaCounterId);
};

Клиенты¶

`geo`¶

Объект с географическими данными клиента. Позволяет показывать разный контент на сайте в зависимости от города, региона и страны посетителя.

Метод / атрибут	Возвращаемый тип	Описание
city	string	Город посетителя
region	string	Регион посетителя
country	string	Страна посетителя

`city`¶

Город клиента

window.onRoistatAllModulesLoaded = function () {
    console.log("Город посетителя: " + window.roistat.geo.city);
};

`region`¶

Регион клиента

window.onRoistatAllModulesLoaded = function () {
    console.log("Регион посетителя: " + window.roistat.geo.region);
};

`country`¶

Страна клиента

window.onRoistatAllModulesLoaded = function () {
    console.log("Страна посетителя: " + window.roistat.geo.country);
};

`authClientByEmail(email)`¶

Ищет клиента с указанным email в системе Roistat и проверяет наличие визита этого клиента — first_visit. Если визит есть, то он указывается в качестве текущего визита для клиента с этим email. Это позволяет объединить визиты клиента с разных устройств.

window.onRoistatModuleLoaded = function () {
    window.roistat.authClientByEmail("test@example.com");
};

Например, вы используете систему авторизации на своем сайте и точно знаете, какой пользователь зашел на сайт. С помощью данного метода вы можете передать email этого пользователя с сайта, чтобы объединить его визиты с разных устройств.

Примечание

Поиск клиента по email осуществляется после запуска метода на сайте.
Визиты объединятся в цепочку после того, как метод отработает.

`authClientById(cliendId)`¶

Ищет клиента с указанным ID из CRM в системе Roistat и проверяет наличие визита этого клиента — first_visit. Если визит есть, то он указывается в качестве текущего визита для клиента с этим ID. Это позволяет объединить визиты клиента с разных устройств.

window.onRoistatModuleLoaded = function () {
    window.roistat.authClientById("1234567");
};

Например, вы используете систему авторизации на своем сайте и точно знаете, какой пользователь зашел на сайт. С помощью данного метода вы можете передать ID этого пользователя с сайта, чтобы объединить его визиты с разных устройств.

Примечание

Поиск клиента по ID осуществляется после запуска метода на сайте.
Визиты объединятся в цепочку после того, как метод отработает.

Коллтрекинг¶

`window.registerOnCalltrackingPhoneReceivedCallback`¶

Колбэк, который вызывается после того, как от сервера получены телефоны для отображения на странице.

window.onRoistatAllModulesLoaded = function () {
    window.roistat.registerOnCalltrackingPhoneReceivedCallback(function() {
        console.log("Получен номер для отображения: " + window.roistat.callTracking.phone);
    });
};

`callTracking`¶

Объект с методами и атрибутами Коллтрекинга.

Метод / атрибут	Возвращаемый тип	Описание
enabled	int	Флаг, отражающий включен ли коллтрекинг на странице
phone	string	Номер коллтрекинга

`enabled`¶

Флаг, отражающий, включен ли Коллтрекинг на странице.

window.onRoistatAllModulesLoaded = function () {
   console.log("Calltracking enabled = " + window.roistat.callTracking.enabled);
};

`phone`¶

Номер коллтрекинга.

window.onRoistatAllModulesLoaded = function () {
    window.roistat.registerOnCalltrackingPhoneReceivedCallback(function () {
         console.log("Calltracking replacement phone recieved: " + window.roistat.callTracking.phone);
    });
};

`disableCallTracking()`¶

Отключает работу Коллтрекинга на странице.

window.onRoistatModuleLoaded = function () {
    window.roistat.disableCallTracking();
};

`window.roistat.setCallTrackingManualMode()`¶

Переключает Коллтрекинг в ручной режим. В этом режиме номера коллтрекинга на странице не будут отображаться автоматически.

window.onRoistatModuleLoaded = function () {
    window.roistat.setCallTrackingManualMode();
};

`window.roistatCallTrackingRefresh()`¶

Запрашивает номера для коллтрекинга.

window.onRoistatModuleLoaded = function () {
    window.roistat.setCallTrackingManualMode(); //Включаем ручной режим коллтрекинга

    document.getElementById("button").onclick = function() {
        window.roistatCallTrackingRefresh(); //Получаем и обновляем номера
    };
};

`window.roistatCalltrackingScripts`¶

Включает определенные сценарии Коллтрекинга на странице. При этом другие сценарии не будут работать на этой странице.

<script> window.roistatCalltrackingScripts = [N]; </script>

N – номер сценария. Можно указать несколько номеров через запятую. Номер сценария можно найти в настройках сценария справа от его названия.

Ловец лидов¶

`onRoistatLeadHunterInited`¶

Колбэк-функция. Вызывается после того, как модули виджета Ловец лидов зарегистрировали свои настройки и методы, с которыми можно взаимодействовать.

Колбэки, которые вызываются после onRoistatLeadHunterInited:

onAfterAppear – вызывается перед появлением формы Ловца лидов.
onAfterSubmit – вызывается перед отправкой формы Ловца лидов.
onBeforeAppear – вызывается после появления формы Ловца лидов.
onBeforeSubmit – вызывается после отправки формы Ловца лидов.

window.onRoistatLeadHunterInited = function () {
   window.roistat.leadHunter.form.autoShowTime = 50; // Показывать Ловец лидов через 50 секунд
};

`leadHunter`¶

Объект с методами и атрибутам для работы с Ловцом лидов.

Метод / атрибут	Возвращаемый тип	Описание
additionalNotifyEmail	string	Дополнительный email для оповещения о лиде
form.autoShowTime	int	Количество секунд, через которое нужно автоматически показать форму Ловца лидов
form.buttonText	string	Текст на кнопке Ловца лидов
form.contactLabel	string	Текст в поле с номером телефона
form.isNameRequired	boolean	Флаг, показывающий, является ли поле с именем обязательным для заполнения
form.isNeedExplicitAgreement	boolean	Флаг, показывающий, является ли согласие на обработку персональных данных обязательным
form.nameLabel	string	Текст в поле с именем
form.subTitle	string	Подзаголовок формы Ловца лидов
form.thankYouText	string	Текст после отправки формы
form.title	string	Заголовок формы Ловца лидов
isEnabled	boolean	Флаг, показывающий, включен ли Ловец лидов
localization.translateToEnglish()	void	Функция для перевода формы Ловца лидов на английский язык
localization.translateToRussian()	void	Функция для перевода формы Ловца лидов на русский язык
onAfterAppear	function()	Колбэк, который вызывается перед появлением формы Ловца лидов
onAfterSubmit	function(lead)	Колбэк, который вызывается перед отправкой формы Ловца лидов
onBeforeAppear	function()	Колбэк, который вызывается после появления формы Ловца лидов
onBeforeSubmit	function(lead)	Колбэк, который вызывается после отправки формы Ловца лидов

Примечание

При настройке текстов Ловца лидов с помощью JavaScript SDK можно использовать HTML-теги. Например, для переноса строки:

window.roistat.leadHunter.form.subTitle = "Перва строка <br> Вторая строка";

`additionalNotifyEmail`¶

Дополнительный email для оповщения о лиде. Необходимо установить до отправки формы Лоцва лидов.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeSubmit = function(lead) {
    window.roistat.leadHunter.additionalNotifyEmail = "myemail@roistat.com";
  }
};

`form.autoShowTime`¶

Количество секунд, через которое нужно автоматически показать форму Ловца лидов.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.form.autoShowTime = 10; //Показывать ловец лидов через 10 секунд
};

`form.buttonText`¶

Текст на кнопке Ловца лидов.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeAppear = function(eventType) {
    window.roistat.leadHunter.form.buttonText = "Текст на кнопке";
  }
};

`form.contactLabel`¶

Текст в поле с номером телефона.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeAppear = function(eventType) {
    window.roistat.leadHunter.form.contactLabel = "Введите номер телефона";
  }
};

`form.isNameRequired`¶

Флаг, определяющий, является ли поле с именем обязательным для заполнения.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeAppear = function(eventType) {
    window.roistat.leadHunter.form.isNameRequired = true;
  }
};

`form.isNeedExplicitAgreement`¶

Флаг, определяющий, является ли согласие на обработку персональных данных обязательным.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeAppear = function(eventType) {
    window.roistat.leadHunter.form.isNeedExplicitAgreement = true;
  }
};

`form.nameLabel`¶

Текст в поле с именем.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeAppear = function(eventType) {
    window.roistat.leadHunter.form.nameLabel = "Введите ваше имя";
  }
};

`form.subTitle`¶

Подзаголовок формы Ловца лидов.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeAppear = function(eventType) {
    window.roistat.leadHunter.form.subTitle = "Подзаголовок";
  }
};

`form.thankYouText`¶

Текст после отправки формы.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeAppear = function(eventType) {
    window.roistat.leadHunter.form.thankYouText = "Спасибо, скоро мы с вами свяжемся";
  }
};

`form.title`¶

Заголовок формы Ловца лидов.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeAppear = function(eventType) {
    window.roistat.leadHunter.form.title = "Заголовок";
  }
};

`isEnabled`¶

Флаг, определяющий, включен ли Ловец лидов.

window.onRoistatLeadHunterInited = function () {
    window.roistat.leadHunter.isEnabled = false; //отключить ловец лидов на странице
};

`localization.translateToEnglish()`¶

Функция для перевода формы Ловца лидов на английский язык.

window.onRoistatLeadHunterInited = function () {
    window.roistat.leadHunter.localization.translateToEnglish();
};

`localization.translateToRussian()`¶

Функция для перевода формы Ловца лидов на русский язык.

window.onRoistatLeadHunterInited = function () {
    window.roistat.leadHunter.localization.translateToRussian();
};

`onAfterAppear`¶

Колбэк, который вызывается перед появлением формы Ловца лидов.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onAfterAppear = function() {
    console.log("Форма ловца лидов показана пользователю");
  }
};

`onAfterSubmit`¶

Колбэк, который вызывается после отправки формы Ловца лидов. В качестве атрибута функции используется объект lead, в котором находятся методы и атрибуты лида.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onAfterSubmit = function(lead) {
    console.log("Форма ловца лидов отправлена");
  }
};

`onBeforeAppear`¶

Колбэк, который вызывается перед появлением формы Ловца лидов. Принимает параметр eventType, в котором указывается событие, по которому показалась форма Ловца Лидов. Возможные значения eventType: click, auto, exit.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeAppear = function(eventType) {
    console.log("Сейчас будет показана форма ловца лидов по событию "+eventType);
  }
};

`onBeforeSubmit`¶

Колбэк, который вызывается после отправки формы Ловца лидов. В качестве атрибута функции используется объект lead, в котором находятся методы и атрибуты лида.

window.onRoistatLeadHunterInited = function () {
  window.roistat.leadHunter.onBeforeSubmit = function(lead) {
    lead.isNeedCallback = 0; // Не совершать обратный звонок
    lead.callbackPhone = 79999999999 //Номер менеджера, куда совершить звонок

    console.log("Дополнительные поля лида: " + lead.fields );
    console.log("Имя лида: " + lead.name );
    console.log("Телефон лида: " + lead.phone );
  }
};

`window.roistatLeadHunterUpdate()`¶

Метод для принудительного обновления масштаба и размера формы Ловца лидов. Используйте его, если форма отображается некорректно при изменении масштаба и размера элементов на странице. Метод нужно вызывать после кода для изменения масштаба и размера.

// Ваш код для изменения масштаба и размера элементов на странице:

async function addCustomZoom() {...}
async function customResize() {...}

await addCustomZoom();
await customResize();

// После окончания всех манипуляций с масштабом и размером принудительно обновите позиционирование формы:

window.roistatLeadHunterUpdate();

`window.roistatLeadHunterShow()`¶

Показывает форму Ловца лидов на странице.

window.onRoistatLeadHunterInited = function () {
    document.getElementById("button").onclick = function() {
        window.roistatLeadHunterShow();
    };
};

Мультивиджет¶

`onRoistatMultiwidgetInited`¶

Колбэк-функция. Вызывается после того, как модули Мультивиджета зарегистрировали свои настройки и методы, с которыми можно взаимодействовать.

window.onRoistatMultiwidgetInited = function () {
   window.roistatMultiwidgetShow();
};

`multiwidget`¶

Объект с настройками Мультивиджета.

Метод / атрибут	Возвращаемый тип	Описание
fb	object	Объект с настройками кнопки Мультивиджета Facebook¹
isEnabled	boolean	Флаг, определяющий, включен ли Мультивиджет
isVisible	boolean	Флаг, определяющий, видна ли кнопка Мультивиджета
telegram	object	Объект с настройками кнопки Мультивиджета Telegram
vk	object	Объект с настройками кнопки Мультивиджета VK

`fb`¶

Объект с настройками кнопки Мультивиджета Facebook.

window.onRoistatAllModulesLoaded = function () {
    console.log("Кнопка Facebook включена: " + window.roistat.multiwidget.fb.isEnabled);
    console.log("Ссылка Facebook: " + window.roistat.multiwidget.fb.link);
};

Поменять ссылку кнопки Facebook:

window.onRoistatModuleLoaded = function () {
    window.roistat.multiwidget.fb.link = "https://newlink.com";
};

`isEnabled`¶

Флаг, определяющий, включен ли Мультивиджет.

window.onRoistatModuleLoaded = function () {
    window.roistat.multiwidget.isEnabled = false; //Выключить Мультивиджет на странице
};

`isVisible`¶

Флаг, определяющий, видна ли кнопка Мультивиджета.

window.onRoistatModuleLoaded = function () {
    window.roistat.multiwidget.isVisible = false; //Скрыть кнопку Мультивиджета на странице
};

При использовании данного флага можно вызвать кнопку Мультивиджета на странице с помощью метода window.roistatMultiwidgetShow().

`telegram`¶

Объект с настройками кнопки Мультивиджета Telegram.

window.onRoistatAllModulesLoaded = function () {
    console.log("Кнопка Telegram включена: " + window.roistat.multiwidget.telegram.isEnabled);
    console.log("Ссылка Telegram: " + window.roistat.multiwidget.telegram.link);
};

Поменять ссылку кнопки Telegram:

window.onRoistatModuleLoaded = function () {
    window.roistat.multiwidget.telegram.link = "https://newlink.com";
};

`vk`¶

Объект с настройками кнопки Мультивиджета VK.

window.onRoistatAllModulesLoaded = function () {
    console.log("Кнопка VK включена: " + window.roistat.multiwidget.vk.isEnabled);
    console.log("Ссылка VK: " + window.roistat.multiwidget.vk.link);
};

Поменять ссылку кнопки VK:

window.onRoistatModuleLoaded = function () {
    window.roistat.multiwidget.vk.link = "https://newlink.com";
};

`window.roistatMultiwidgetShow()`¶

Вызывает кнопку Мультивиджета.

window.onRoistatAllModulesLoaded = function () {
    document.getElementById("button").onclick = function() {
        window.roistatMultiwidgetShow();
    };
};

Онлайн-чат¶

`window.onRoistatOnlineChatInited`¶

Колбэк-функция. Вызывается после того, как модули виджета Онлайн-чат зарегистрировали свои настройки и методы, с которыми можно взаимодействовать.

window.onRoistatOnlineChatInited = function () {
   window.roistatOnlineChatToggle(); // Открыть окно чата
};

`onlineChat`¶

Объект с методами и атрибутами Онлайн-чата.

Метод / атрибут	Возвращаемый тип	Описание
isAvailableForCurrentUserAgent	boolean	Флаг, определяющий, доступен ли Онлайн-чат для текущего user-agent
isEnabled	boolean	флаг, определяющий, Включен ли Онлайн-чат
localization.translateToEnglish()	void	Перевести Онлайн-чат на английский язык
localization.translateToRussian()	void	Перевести Онлайн-чат на русский язык
localization.translate()	void	Перевести Онлайн-чат на язык, добавленный в настройках чата

`isAvailableForCurrentUserAgent`¶

Флаг, определяющий, доступен ли Онлайн-чат для текущего user-agent.

window.onRoistatOnlineChatInited = function () {
    console.log("Онлайн-чат досутпен: " + window.roistat.onlineChat.isAvailableForCurrentUserAgent);
};

`isEnabled`¶

Флаг, определяющий, включен ли Онлайн-чат.

window.onRoistatOnlineChatInited = function () {
    window.roistat.onlineChat.isEnabled = false; //Выключить Онлайн-чат на странице
};

`localization.translateToEnglish()`¶

Перевести Онлайн-чат на английский язык.

window.onRoistatOnlineChatInited = function () {
    window.roistat.onlineChat.localization.translateToEnglish();
};

`localization.translateToRussian()`¶

Перевести Онлайн-чат на русский язык.

window.onRoistatOnlineChatInited = function () {
    window.roistat.onlineChat.localization.translateToRussian();
};

`localization.translate()`¶

Перевести Онлайн-чат на язык, добавленный в настройках чата. Необходимо передавать название языка в виде строки.

window.onRoistatOnlineChatInited = function () {
    window.roistat.onlineChat.localization.translate("Испанский");
};

Чтобы добавить язык чата и настроить тексты, следуйте этой инструкции.

`window.roistatOnlineChatToggle()¶

Показывает окно Онлайн-чата.

window.onRoistatOnlineChatInited = function () {
    document.getElementById("button").onclick = function() {
        window.roistatOnlineChatToggle();
    };
};

`window.setRoistatOnlineChatCustomParams()`¶

Позволяет задать дополнительные параметры чата, которые будут отображаться в интерфейсе операторского приложения.

window.onRoistatOnlineChatInited = function() {
    window.setRoistatOnlineChatCustomParams({
        parameter_name: "parameter_value"
    });
};

Промокоды¶

`window.roistatPromoCodeRefresh()`¶

Обновляет значение промокода Roistat в элементе .roistat-promo.

window.onRoistatAllModulesLoaded = function () {
    document.getElementById("button").onclick = function() {
        window.roistatPromoCodeRefresh();
    };
};

События¶

`event.send(eventName,[eventFields])`¶

Отправляет событие в аналитику.

document.getElementById("button").onclick = function() {
    window.roistat.event.send("some_event", {"value": "123"});
};

Правообладателем Facebook является запрещенная на территории РФ компания Meta Platforms, признанная судом экстремистской. ↩

JavaScript SDK Roistat¶

Описание работы JavaScript SDK¶

Методы объекта window.roistat¶

Методы объекта window¶

Колбэки готовности JS SDK¶

onRoistatModuleLoaded¶

onRoistatAllModulesLoaded¶

Визиты¶

getSource()¶

getVisit()¶

page.params.roistat_param1..5¶

setRoistatParams¶

setVisit(visitId)¶

Email-трекинг¶

emailtracking¶

emails¶

enabled¶

loaded¶

refresh()¶

Интеграции¶

window.roistatMetrikaCounterId¶

Клиенты¶

geo¶

city¶

region¶

country¶

authClientByEmail(email)¶

authClientById(cliendId)¶

Коллтрекинг¶

window.registerOnCalltrackingPhoneReceivedCallback¶

callTracking¶

enabled¶

phone¶

disableCallTracking()¶

window.roistat.setCallTrackingManualMode()¶

window.roistatCallTrackingRefresh()¶

window.roistatCalltrackingScripts¶

Ловец лидов¶

onRoistatLeadHunterInited¶

leadHunter¶

additionalNotifyEmail¶

form.autoShowTime¶

form.buttonText¶

form.contactLabel¶

form.isNameRequired¶

form.isNeedExplicitAgreement¶

form.nameLabel¶

form.subTitle¶

form.thankYouText¶

form.title¶

isEnabled¶

localization.translateToEnglish()¶

localization.translateToRussian()¶

onAfterAppear¶

onAfterSubmit¶

onBeforeAppear¶

onBeforeSubmit¶

window.roistatLeadHunterUpdate()¶

window.roistatLeadHunterShow()¶

Мультивиджет¶

onRoistatMultiwidgetInited¶

multiwidget¶

fb¶

isEnabled¶

isVisible¶

telegram¶

vk¶

window.roistatMultiwidgetShow()¶

Онлайн-чат¶

window.onRoistatOnlineChatInited¶

onlineChat¶

isAvailableForCurrentUserAgent¶

isEnabled¶

localization.translateToEnglish()¶

localization.translateToRussian()¶

localization.translate()¶

`window.roistatOnlineChatToggle()¶

window.setRoistatOnlineChatCustomParams()¶

Промокоды¶

window.roistatPromoCodeRefresh()¶

Методы объекта `window.roistat`¶

Методы объекта `window`¶

`onRoistatModuleLoaded`¶

`onRoistatAllModulesLoaded`¶

`getSource()`¶

`getVisit()`¶

`page.params.roistat_param1..5`¶

`setRoistatParams`¶

`setVisit(visitId)`¶

`emailtracking`¶

`emails`¶

`enabled`¶

`loaded`¶

`refresh()`¶

`window.roistatMetrikaCounterId`¶

`geo`¶

`city`¶

`region`¶

`country`¶

`authClientByEmail(email)`¶

`authClientById(cliendId)`¶

`window.registerOnCalltrackingPhoneReceivedCallback`¶

`callTracking`¶

`enabled`¶

`phone`¶

`disableCallTracking()`¶

`window.roistat.setCallTrackingManualMode()`¶

`window.roistatCallTrackingRefresh()`¶

`window.roistatCalltrackingScripts`¶

`onRoistatLeadHunterInited`¶

`leadHunter`¶

`additionalNotifyEmail`¶

`form.autoShowTime`¶

`form.buttonText`¶

`form.contactLabel`¶

`form.isNameRequired`¶

`form.isNeedExplicitAgreement`¶

`form.nameLabel`¶

`form.subTitle`¶

`form.thankYouText`¶

`form.title`¶

`isEnabled`¶

`localization.translateToEnglish()`¶

`localization.translateToRussian()`¶

`onAfterAppear`¶

`onAfterSubmit`¶

`onBeforeAppear`¶

`onBeforeSubmit`¶

`window.roistatLeadHunterUpdate()`¶

`window.roistatLeadHunterShow()`¶

`onRoistatMultiwidgetInited`¶

`multiwidget`¶

`fb`¶

`isEnabled`¶

`isVisible`¶

`telegram`¶

`vk`¶

`window.roistatMultiwidgetShow()`¶

`window.onRoistatOnlineChatInited`¶

`onlineChat`¶

`isAvailableForCurrentUserAgent`¶

`isEnabled`¶

`localization.translateToEnglish()`¶

`localization.translateToRussian()`¶

`localization.translate()`¶

`window.setRoistatOnlineChatCustomParams()`¶

`window.roistatPromoCodeRefresh()`¶

`event.send(eventName,[eventFields])`¶