Add event properties amplitude android

Пошаговая инструкция: как отправить данные в Amplitude с помощью Google Tag Manager

Что это

Самая подробная инструкция по передаче событий с сайта в сервис продуктовой аналитики Amplitude с помощью Google Tag Manager.

Инструкция написана аналитиками Adventum, digital-агентства и эксклюзивного партнера Amplitude в России и СНГ.

Для кого

Для продакт-менеджеров и аналитиков, которые хотят внедрить Amplitude на сайт,

Для разработчиков, которые будут внедрять Amplitude на сайт,

Для всех, кто слышал об Amplitude и хочет передавать данные о событиях на сайте в эту систему.

Зачем

Amplitude — платформа продуктовой аналитики, основанная на событиях. С ее помощью вы можете анализировать действия пользователей на сайте, в приложении и улучшать свой продукт.

Чтобы события с сайта быстро попадали в Amplitude, вам поможет Google Tag Manager (GTM) — платформа, которая дает возможность управлять JavaScript и HTML-тегами сайта, настроить сбор данных путем добавления кода GTM.

Если вы ни разу не настраивали передачу событий через эти системы, придется потратить много времени, чтобы разобраться. Поэтому мы создали пошаговую инструкцию, которая поможет продакту и разработчику быстро настроить передачу данных в Amplitude с помощью Google Tag Manager.

Содержание

1. Создайте аккаунты в Amplitude и GTM

Создание проекта в Amplitude

Если вы до этого еще не передавали данные через эти системы, создайте аккаунты в Amplitude и GTM.

Чтобы создать аккаунт в Amplitude, на главной странице нажмите Explore Product:

Укажите почту для регистрации:

Выберите сферу вашей деятельности:

Укажите имя, название компании и нажмите Explore demo now:

Перейдите в настройки:

И нажмите Create Organization:

Укажите название компании, url и нажмите Create:

Далее можно указать сферу деятельности команды в компании или пропустить этот шаг, нажав на крестик в углу.

Если вы собираете данные от жителей Европейского союза (ЕС), то вам нужно будет заполнить Data Processing Agreement (DPA) — Соглашение о защите персональных данных (в соответствии с правилами Общего регламента по защите данных (GDPR)).

Если не собираете — нажмите We Don’t Need a DPA:

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

Чтобы создать проект в настройках, перейдите на вкладку Projects и нажмите Create Project:

Введите имя проекта и нажмите Create:

Готово — вы создали проект. Теперь нужно создать проект в Google Tag Manager и приступить к настройке.

Создание проекта в GTM

Зайдите на главную страницу GTM и нажмите Start for free.

Для входа используйте аккаунт Google или создайте при регистрации, если ранее его не настраивали.

Нажмите Создать аккаунт:

Введите название аккаунта и выберите страну.

Затем укажите название контейнера, платформу, и нажмите Создать. После этого нужно согласиться с условиями использования Диспетчера тегов Google.

Предварительные действия завершены. Теперь у вас есть аккаунты в Amplitude и GTM. Приступим к настройке передачи событий.

2. Добавьте код GTM на сайт

ID вашего контейнера GTM находится в верхнем правом углу.

Контейнер GTM — это небольшой фрагмент кода на JavaScript, который добавляется на страницы сайта.

Чтобы внедрить GTM на своем сайте, выполните следующие действия:

1. Скопируйте приведенный ниже код JavaScript, замените GTM-XXXX идентификатором своего контейнера и добавьте код на все страницы сайта как можно ближе к открывающему тегу .

2. Скопируйте следующий фрагмент и вставьте его на все страницы сайта сразу после открывающего тега , заменив GTM-XXXX идентификатором контейнера.

3. Добавьте тег для инициализации Amplitude JavaScript SDK

Для передачи событий будем использовать Amplitude JavaScript SDK. Добавим тег для инициализации SDK.

В Amplitude нужно зайти в Sources & Destinations:

И нажать Add Data Source:

Далее выберите JavaScript SDK и нажмите Next:

Целиком скопируйте код SDK в появившемся окне:

Перейдите в GTM и на главной странице аккаунта нажмите Добавить новый тег:

Сверху укажите название тега: tag_Amplitude_SDK. Приписка в начале названия позволит легче находить тег в интерфейсе GTM.

Нажмите на иконку конфигурации тега:

В появившемся списке выберите Пользовательский HTML:

И вставьте скопированный в Amplitude код JS SDK:

После этого нажмите на иконку триггера:

И установите триггер All pages, чтобы код SDK инициализировался при загрузке каждой страницы сайта:

Нажмите Сохранить:

❗️ Amplitude периодически дорабатывает JS SDK и публикует новые версии. Не забывайте проверять наличие новых версий SDK и обновлять код в теге, это поможет предотвратить ошибки при передаче данных. Актуальную версию смотрите на странице JavaScript и узнавайте об изменениях в релизах.

Далее нужно добавить:

тег для отправки событий просмотра страниц,

теги для отправки событий и свойств пользователя,

триггеры (условия, при котором активируются теги),

переменные (объекты для формирования названий событий и значений свойств).

Как это сделать, рассказываем ниже.

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

4. Создайте реестр событий и свойств пользователя

Событие — действие, которое пользователь выполняет в продукте (запускает игру, добавляет товар в корзину) или действие, связанное с пользователем (push-уведомления).

Перед тем, как вы начнете отправлять события — важно понять, какие события отправлять и записать их в единый реестр. Иначе могут возникнуть проблемы с внедрением: пропущенные события или неправильные названия приведут к тому, что вы не будете видеть полную картину действий пользователя в продукте. Вы не сможете правильно толковать их поведение, строить отчеты, в итоге пропадет доверие к данным и возможность принимать верные решения.

Нужно ли отправлять все действия пользователя? Чаще всего нет, по крайне мере, на первых этапах. Начните с воронок основных процессов в продукте: онбординг, регистрация, покупка.

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

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

Вариант реестра может выглядеть так:

События:

Категория события

Название события

Описание

Свойства события

Успешная регистрация пользователя

Просмотр главной страницы

Просмотр карточки товара

Товар добавлен в корзину

Товар добавлен в избранное

Свойства пользователя:

Количество товаров в избранном

Дата регистрации в iso формате

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

5. Три способа настройки GTM для передачи событий в Amplitude

Мы описываем 3 способа настройки GTM для передачи событий в Amplitude, выберите подходящий для вашего продукта:

Способ №1 внедряется быстрее остальных, требует меньше работы с GTM. Подойдет, если у событий в вашем продукте немного свойств, и есть быстрый доступ к изменению кода сайта.

Способ №2 позволяет быстро вносить изменение изменения в свойства отправляемых событий через GTM. Подойдет для продуктов с большим количеством свойств, если их значения не содержат массивов.

Способ №3 позволяет передавать значения свойств событий массивами. Подойдет для сложных продуктов.

❗️ Приведенный способ передачи данных в Google Tag Manager — структура событий и настроек — позволит легко использовать их и в других системах аналитики, или для настройки рекламных пикселей. Также структура легко ложится на схему передачи событий в Google Analytics (Universal) — за счет чего можно передавать данные в обе системы без особых корректировок.

Способ №1

Уровень данных (dataLayer) хранит и передает информацию с вашего сайта в Google Tag Manager.

Чтобы отправить данные в dataLayer, используют метод push.

В этом способе рассмотрим отправку пуша следующего вида:

event:

addEvents_makeConversions — действия в рамках определенной воронки,

addEvents_clickLinks — клики по ссылкам, ведущим на внешний домен,

addEvents_useNavigations — клики по навигационным элементам,

addEvents_makeActions — все прочие действия.

Для простоты можете делить события на addEvents_makeConversions и addEvents_makeActions.

event_id — идентификатор события согласно инструкции (в примере d-v1-e1 : версия инструкции (v — version) 1, номер события (e — event) 1),

event_cat — категория события,

event_name — название события,

event_param — параметр для передачи свойств.

Согласно реестру событий нам нужно отправлять следующие пуши:

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

Если вы планируете отправлять одно и тоже событие как со свойствами, так и без них, тогда, в случае, если событие отправляется без какого-то свойства, нужно прописывать в пуше значение этого свойства null. Например:

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

Для создания триггера в раздел Триггеры и нажмите Создать:

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

В появившимся списке выберите Пользовательское событие:

Введите в поле Имя события addEvents и поставьте галочку напротив Использовать регулярные выражения. Это позволит GTM определить события, которые вы отправляете в dataLayer (если в параметре event будет содержаться addEvents, то триггер сработает).

В условиях активации триггера оставьте Все специальные события, нажмите Сохранить, и триггер добавится.

Чтобы создать переменные, зайдите в раздел Переменные и нажмите Создать:

Кликните на иконку конфигурации переменной:

В появившемся окне нажмите Переменная уровня данных (datalayer variables), так как вы будете отправлять события и параметры через dataLayer.push.

Введите имя переменной, используя формат varDL_<<название переменной>>.

В поле Имя переменной уровня данных впишите <<название переменной>>.

Для параметра event_cat переменная будет выглядеть так:

Таким же образом добавляйте остальные параметры:

Имя переменной в GMT

Имя переменной в dataLayer

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

зайдите в раздел Переменные и нажмите Создать.

в появившемся окне введите название LT_Amplitude_event, нажмите на иконку конфигурации переменной и в появившемся списке выберите Таблица поиска.

Установите входную переменную <> и добавьте 5 строк. Эта таблица поиска будет определять тип события и составлять название, используя переменную категории (varDL_event_cat) и названия (varDL_event_name). Вам нужно для каждого типа событий добавить строку в таблице поиска:

Входные данные

Результат

Чтобы не возникла ошибка при отправке события, если в таблице поиска не найдено соответствующее значение, установите галочку напротив Установить значение по умолчанию и введите значение по умолчанию (not_set).

Нажмите Сохранить.

Триггер и переменные добавлены. Теперь переходим к созданию тегов.

На вкладке Обзор нажмите Добавить новый тег:

Назовите новый тег tagWA_Amplitude_Events, затем нажмите иконку конфигурации тега и выберите в списке Пользовательский HTML (так же, как делали при добавлении AMPLITUDE JS SDK).

Код состоит из двух функций:

Функция mainTagFunction отправляет события в Amplitude и обнуляет значение event_param в dataLayer. Обнуление нужно потому, что метод push только добавляет данные в dataLayer. Если не обнулить event_param после отправки пуша, в параметры следующего события попадут параметры из предыдущего. Такое еще может произойти, если вы случайно отправите событие без передачи event_param.

Функция amplitudeSdkSearch проверяет, инициализировался ли Amplitude JS SDK. Если SDK инициализирован, вызывается функция mainTagFunction . Если не добавить эту функцию, может произойти такая ситуация: код SDK еще не загрузился, а пуш события уже отправлен, тогда событие не отправится в Amplitude.

Затем выберите для тега триггер DL_event_addEvents:

Нажмите Сохранить и тег добавится в контейнер.

Так же добавьте тег tag_Amplitude_SDK.

❗️ Amplitude периодически дорабатывает JS SDK и публикует новые версии. Не забывайте проверять наличие новых версий SDK и обновлять код в теге, это поможет предотвратить ошибки при передаче данных. Актуальную версию смотрите на странице JavaScript и узнавайте об изменениях в релизах.

Настройка GTM завершена.

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

Если вы хотите передавать свойства событий в другие системы, например, Google Analytics, то понадобится дополнительно настраивать GTM, либо отправлять свойства в dataLayer в другом виде.

Варианты отправки событий, лишенные этих недостатков, будут описаны в способе 2 и 3.

Cпособ №2

Используя данный способ, не получится передавать значения параметров в виде массивов.

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

Рассмотрим отправку пуша‎ следующего вида:

Этот пуш отличается от пуша из первого способа тем, что вы передаете свойства события как отдельные пары «ключ-значение», а не в event_param.

Согласно реестру событий необходимо будет отправлять следующие пуши:

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

Если вы планируете отправлять одно и тоже событие как со свойствами, так и без них, тогда, в случае если событие отправляется без какого-то свойства, нужно прописывать в пуше значение этого свойства null. Например:

Также можно просто не прописывать это свойство в пуше, но тогда нужно при создании переменной для этого свойства в GTM установить значение по умолчанию “”:

Создайте переменные уровня данных.

Согласно реестру событий, необходимо добавить следующие переменные:

Имя переменной в GMT

Имя переменной в dataLayer

После добавления этих переменных, переходим к созданию таблиц поиска.

Добавьте таблицу поиска LT_Amplitude_event.

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

В разделе Переменные нажмите Создать, введите название LT_Amplitude_params, выберите тип переменной Таблица поиска.

Важно изменить входную переменную на <>: таблица будет получать названия событий и передавать соответствующие им свойства.

Далее добавьте в таблицу строки:

в поле Входные данные будут названия событий,

в поле Результат будут свойства событий в формате <"название свойства 1": "<<название переменной 1 в gtm>>», «название свойства 2»: «<<название переменной 2 в gtm>>»> . Важно использовать именно двойные кавычки (а не как в dataLayer.push одинарные), иначе свойства не будут отправляться.

Для событий из реестра в таблице поиска LT_Amplitude_params нужно записать следующие значения:

Входные данные

Результат

Событие conversionStep_[purchase]_main_page_view не нужно добавлять в эту таблицу, потому что у него нет свойств.

Поставьте галочку напротив Установить значение по умолчанию и введите значение по умолчанию «» (две двойные кавычки). Так, если в пуше не будет свойств, ошибка при отправке события не возникнет.

Нажмите Сохранить, и таблица поиска добавится в контейнер.

Далее добавьте триггер DL_event_addEvents:

После этого добавьте тег tag_Amplitude_SDK.

❗️ Amplitude периодически дорабатывает JS SDK и публикует новые версии. Не забывайте проверять наличие новых версий SDK и обновлять код в теге, это поможет предотвратить ошибки при передаче данных. Актуальную версию смотрите на странице JavaScript и узнавайте об изменениях в релизах.

Тег для отправки событий и свойств будет отличаться от тега из первого способа: добавьте тег с названием tagWA_Amplitude_Events и триггером DL_event_addEvents, выберите тип тега Пользовательский HTML и добавьте этот код:

Он также содержит функцию amplitudeSdkSearch , которая проверяет, инициализировался ли Amplitude JS SDK.

Внутрь функции mainTagFunction добавлена переменная obj , которая с помощью метода JSON.parse преобразовывает JSON обратно в объект. Это необходимо, потому что таблица поиска в GTM преобразовывает конечное значение в формат строки, а свойства события должны передаваться как объект. Именно из-за этой особенности таблицы поиска, используя второй способ, не получится передавать значения в виде массивов.

Нажмите Сохранить, и тег добавится в контейнер.

Способ №3

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

Пуши в dataLayer отличаются от пушей во втором способе тем, что в значениях свойств нужно будет добавить метод JSON.stringify :

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

Если вы планируете отправлять одно и тоже событие как со свойствами, так и без них, тогда, в случае если событие отправляется без какого-то свойства, нужно прописывать в пуше значение этого свойства null. Например:

Также можно просто не прописывать это свойство в пуше, но тогда нужно при создании переменной для этого свойства в GTM установить значение по умолчанию «»:

Добавьте следующие переменные:

Имя переменной в GMT

Имя переменной в dataLayer

Источник