Перейти к основному содержимому

Команды для отправки событий через Web SDK

Краткое содержание

User Id
Команда ma('setUserId', '<USER_ID>') задает идентификатор пользователя.

Pageview
Команда ma('pageview', <MESSAGE_PARAMS>) отправляет информацию о просмотре страницы. Параметр MESSAGE_PARAMS может содержать произвольные данные, например, { category: "Videos", action: "View", label: "Toy Story" }.

Custom message
Команда ma('message', <EVENT_NAME>, <MESSAGE_PARAMS>) отправляет произвольное событие. Параметр EVENT_NAME указывает имя события, а MESSAGE_PARAMS — его параметры.

Trigger message
Команда ma('trigger', <TRIGGER_NAME>, <TRIGGER_PARAMS>) отправляет триггерные события. Параметр TRIGGER_PARAMS включает status (например, "START", "STOP", "DONE") и необязательный time в секундах.

Параметры сообщения
MESSAGE_PARAMS — произвольные параметры для событий. Специальные поля:

  • location — URL страницы (по умолчанию document.location.href).
  • title — заголовок страницы (по умолчанию document.title).
  • notInteraction — указывает, является ли событие интерактивным (по умолчанию true).
  • external — обозначает источник события (по умолчанию false).

Вы можете задать команды отправки событий в библиотеку МТС Аналитики и внести их напрямую в код.

User Id​

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

ma('setUserId', '<USER_ID>');

USER_ID — идентификатор пользователя.

Pageview​

Отправляет информацию о просмотре страницы

ma('pageview', <MESSAGE_PARAMS>);

MESSAGE_PARAMS — произвольные объект. Например, { category: "Videos", action: "View", label: "Toy Story" }.

Custom message​

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

ma('message', <EVENT_NAME>, <MESSAGE_PARAMS>);

EVENT_NAME — имя события. Например, youtube_video.

MESSAGE_PARAMS — параметры события, задаются произвольно. Например: { category: "Videos", action: "View", label: "Toy Story" }.

Trigger message​

Команда отправки триггерных событий

ma('trigger', <TRIGGER_NAME>, <TRIGGER_PARAMS>);

TRIGGER_NAME — имя триггера.

TRIGGER_PARAMS — объект типа { status: "DONE", time: 3600 }, где

  • status — cтатус триггера, например «START», — начать отсчёт таймера, «STOP» — остановить отсчёт таймера, «DONE» — триггер сработал.
  • time — время до тайм-аута, передается в секундах (необязательный параметр).

Параметры сообщения​

MESSAGE_PARAMS — произвольные параметры для каждого события.

Ниже перечислены специальные поля, при установке они будут передаваться с каждым событием в специальном поле мета-информации.

location​

Позволяет указать URL страницы. Если параметр не задан, берется текущее значение document.location.href

ma('pageview', {location: 'http://mts.ru'});

title​

Позволяет указать заголовок страницы. Если параметр не задан, берется текущее значение document.title

ma('pageview', {title: 'YourBrand'});

notInteraction​

Указывает, событие интерактивное или неинтерактивное. По умолчанию все события передаются со значением true. false — обозначает, что событие не интерактивно (не связано с действиями пользователя)

ma('pageview', {notInteraction: true});

external​

Указывает, что событие пришло из внешнего источника, например, из iFrame. По умолчанию — false

ma('pageview', {external: true});