Регистрация просмотра профиля

Регистрация просмотров профилей является обязательным требованием использования API 2ГИС. Она осуществляется через подключение JS-трэкера.

JS Tracker

Для работы с трэкером используется JavaScript-объект DG.apitracker. Он становится доступным после загрузки следующего кода:

<script src="http://catalog.api.2gis.ru/assets/apitracker.js"></script>

Кстати, напоминаем, что данный файл должен подключаться на каждой странице, где используется API 2ГИС.

Просмотр профиля

Регистрация события просмотра профиля происходит через вызов метода DG.apitracker.regBC( [reg_bc_url] ), где [reg_bc_url] — набор дополнительных данных для регистрации события, которые получаются в профиле филиала организации в поле reg_bc_url.

Вызов метода трэкера DG.apitracker.regBC() осуществляется следующими способами:

  • размещением кода вызова перед тегом;
  • размещением кода вызова в обработчике события onLoad тэга;
  • размещением кода вызова в любом произвольном коде, гарантирующем вызов регистрации события после загрузки профиля филиала организации.

Пример вызова регистрации события при загрузке страницы:

<html>
<body onload="DG.apitracker.regBC('http://stat.api.2gis.ru/?v=2.0&hash=a6ffd3544cc0dfe277c3');">
</body>
</html>

Дополнительные события

Помимо регистрации события просмотра профиля рекомендуются регистрировать Дополнительные события.

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

Регистрация происходит через вызов метода DG.apitracker.regBCEvent( [reg_bc_url], [event_type] ), где [reg_bc_url] — те же данные, что использовались при регистрации просмотра профиля, а [event_type] — событие, которое совешил пользователь из следующего списка:

  • show_address — Адреса организации. Регистрируется при отображения блока адреса организации
  • show_contact_email — email. Регистрируется при отображении контакта с типом email
  • show_contact_phone — Номер телефона. Регистрируется при отображении контакта с типом phone
  • show_contact_skype — skype. Регистрируется при отображении контакта с типом skype
  • show_contact_social_profile — Контакт социальной сети. Регистрируется при отображении контакта с типами vkontakte, twitter, instagram, facebook, odnoklassniki, googleplus, linkedin, youtube, pinterest

Пример вызова регистрации события при клике в кнопку Показать телефон:

<html>
<head>
<script type="text/javascript">
function showHiddenData() {} // - ваша функция, которая отображает скрытые данные
</script>
</head>
<body onload="DG.apitracker.regBC(...);">
<div>
Телефон: +7 123 45
<input
type="button"
onclick="
showHiddenData();
DG.apitracker.regBCEvent(
'http://stat.api.2gis.ru/?v=2.0&hash=a6ffd3544cc0dfe277c3',
'show_contact_phone'
);
"
value="Показать телефон"/>
</div>
</body>
</html>

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