Методы по работе со счетчиком

ВНИМАНИЕ! Перед вызовом методов следует убедиться, что экземпляр счетчика создан и доступен. Данные не будут собираться, если счётчик ещё не создан, т.к. их не с чем связать.
Поддерживаются следующие методы по работе со счетчиком:

Отправка события о просмотре страницы

Метод используется для single-page application для реализации корректного подсчёта статистики. В код страницы необходимо добавить вызов метода trackPageview для созданного экземпляра счетчика в те моменты, когда необходимо отправлять события показа страницы. Опционально можно передать url страницы. Если url не передан, то счетчик сам его возьмет из location.href (без учета хэш). Если нужно учитывать хэши, то необходимо активировать учет хэшей
top100Counter.trackPageView("URL");
URL (опциональный) - url web страницы, например, "https://rambler.ru"
Примеры вызова в коде страницы метода:
window.top100Counter.trackPageview();
window.top100Counter.trackPageview('https://rambler.ru');

Отправка собственных событий

Метод sendCustomVars [ Устаревший ]

Метод используется для передачи пользовательских переменных: принимает на вход объект {param1:value1, …, paramN:valueN} и отправляет эти данные в счетчик. Подробнее про вызов метода – см. «Передача параметров визита».
top100Counter.sendCustomVars({ param1: "value1", …, paramN: "valueN" });
Примеры вызова в коде страницы метода:
window.top100Counter.sendCustomVars({
param1: 'value1',
param2: 'value2'
});

Метод trackEvent [ New ]

Метод используется для отправки собственных событий. Для этого необходимо его вызвать и передать название события и данные для события:
top100Counter.trackEvent("EVENT_NAME", EVENT_DATA);
EVENT_NAME (обязательный) — произвольное название события
EVENT_DATA (опциональный) — произвольные данные о событии, в формате объекта с вложенными параметрами, не более 30 параметров и уровней вложенности не более 5
Пример вызова метода:
const eventName = 'my_event';
const eventData = {
param1: 'value1',
param2: {
param3: 'value2',
},
};
window.top100Counter.trackEvent(eventName, eventData);

Метод для передачи идентификатора авторизованного пользователя

Метод используется для передачи идентификатора авторизованного пользователя: принимает на вход идентификатор и отправляет его в счетчик. Таким образом можно переопределить значение user_id, указанное в настройках счётчика при инициализации. Подробнее про передачу идентификатора пользователя – см. «Передача идентификатора пользователя».
top100Counter.syncUserId("USER_ID" || null);
USER_ID - идентификатор пользователя или null, если человек разлогинился
Примеры вызова в коде страницы метода:
window.top100Counter.syncUserId(null); // выход пользователя
window.top100Counter.syncUserId('abcde1234'); // id авторизованного пользователя

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

Метод для получения данных об идентификаторе пользователя, устанавливаемого площадкой, и его области применения.
top100Counter.getPublisherId();
Пример использования метода:
const pub_id = window.top100Counter.getPublisherId();

Метод для отрисовки виджета на странице

Метод следует вызывать на страницах сайта с указанием места, где нужно разместить виджет. На вход необходимо передавать идентификатор элемента на странице, в который будет отрисован виджет (значение идентификатора element может быть также указано в атрибутах cчетчика при инициализации). Вызов метода необходимо добавить в код каждой из страниц, где требуется разместить виджет.
top100Counter.drawLogoTo("ELEMENT_ID");
ELEMENT_ID - значение идентификатора element, где должен быть отрисован виджет
Пример вызова метода:
window.top100Counter.drawLogoTo('top100_widget'); // id элемента где будет отрисован виджет

Метод для сканирования и отправки блоков

Метод для дополнительного поиска элементов, указанных в «Аналитике блоков» и последующей отправке по ним данных. В метод можно передать DOM элемент - контейнер в рамках которого нужно осуществить поиск показанных блоков.
top100Counter.sendBlocks();
Примеры вызова метода:
window.top100Counter.sendBlocks();
const container = document.getElementById('container');
window.top100Counter.sendBlocks(container);

Метод для обновления параметров счетчика

Метод для обновления параметров счетчика. Обновляет ограниченное кол-во параметров конкретного счетчика. Список параметров счетчика указан в разделе Атрибуты счетчика. Также с помощью метода можно установить email пользователя.
top100Counter.updateOptions(COUNTER_PARAMS)
COUNTER_PARAMS - объект с параметрами которые необходимо обновить. Список параметров счетчика указан в разделе Атрибуты счетчика.
Пример использования метода:
window.top100Counter.updateOptions({ email: '[email protected]' }); // email пользователя