Использование плагинов

Плагины позволяют добавить в библиотеку analytics.js дополнительные функции для отслеживания действий пользователей. Они обычно создаются для конкретных функций Google Analytics, например электронной торговли или междоменного отслеживания, поэтому они не включены в библиотеку analytics.js по умолчанию.

Из этой статьи вы узнаете, как запрашивать и использовать плагины Google Analytics.

Как запросить плагин

Команда require принимает в качестве аргумента название плагина и регистрирует его для последующего использования в очереди команд ga(). Если плагин поддерживает настройки конфигурации, они могут быть переданы в качестве последнего аргумента команды require.

Вот полная сигнатура команды require:

ga('[trackerName.]require', pluginName, [pluginOptions]);

В примере ниже показано, как запросить плагин электронной торговли для счетчика по умолчанию:

ga('require', 'ec');

Так можно запросить плагин функций для контекстно-медийной сети для счетчика myTracker и изменить название файла cookie по умолчанию:

ga('myTracker.require', 'displayfeatures', {
  cookieName: 'display_features_cookie'
});

Загрузка кода по умолчанию

Команда require инициализирует методы плагина для использования в очереди команд ga(), но не загружает его скрипт. Если вы используете сторонний плагин или создаете его самостоятельно, необходимо вручную добавить его код на страницу.

Делать это рекомендуется с помощью тега <script> с атрибутом async, чтобы при этом не блокировалась загрузка прочих функций сайта.

Код в примере ниже запрашивает и загружает плагин отслеживания ссылок:

<script>
ga('create', 'UA-XXXXX-Y', 'auto');
ga('require', 'linkTracker');
ga('send', 'pageview');
</script>

<!--Note: plugin scripts must be included after the tracking snippet. -->
<script async src="/path/to/link-tracker-plugin.js"></script>

Ожидание загрузки плагинов

Библиотека и плагины analytics.js загружаются асинхронно, поэтому не так просто определить, когда плагины загрузились и готовы к использованию.

Для решения этой проблемы analytics.js приостанавливает выполнение очереди команд при обнаружении команды require для незагруженного плагина. Как только он будет получен, очередь начнет обрабатываться дальше.

Очень важно, чтобы плагины работали корректно. Если при его загрузке или выполнении происходит ошибка, последующие команды не будут выполнены.

Как вызвать методы плагина

После запроса плагина его методы можно использовать в очереди команд ga(). Для этого используется следующая сигнатура:

ga('[trackerName.][pluginName:]methodName', ...args);

Например, вызвать метод addProduct плагина addProduct можно следующим образом:

ga('ec:addProduct', {
  'id': 'P12345',
  'quantity': 1
});

Если у счетчика есть название, его можно добавить в командную строку:

ga('myTracker.ec:addProduct', {
  'id': 'P12345',
  'quantity': 1
});

Дополнительная информация

Если вы изучили все руководства в этом разделе, то теперь знакомы с основными функциями analytics.js. В следующей статье вы прочитаете о том, как выполнять отладку analytics.js, чтобы быстрее находить ошибки и проверять работу кода.