Amplitude

Renta отправляет строки из вашего хранилища данных в Amplitude в виде одного из двух объектов: событий и профилей пользователей.

Строка события содержит User ID человека, имя события и любые колонки, которые вы направили в event properties или user properties. Строка профиля содержит User ID и свойства, которые попадут в профиль этого человека в Amplitude.

Аутентификация

Для аутентификации в Amplitude Renta использует project API key. Ключ работает только с одним проектом, поэтому для каждого проекта Amplitude создайте отдельное назначение.

Для подключения понадобятся два параметра из Amplitude:

1. В Amplitude откройте Settings > Projects, выберите проект и перейдите на вкладку API Keys. Скопируйте API key.
2. Определите регион данных проекта: US или EU. Проекты Amplitude в этих регионах работают как отдельные системы, и ключ принадлежит только одному из них.

Renta проверяет ключ, когда вы сохраняете назначение. Проверка ничего не записывает, поэтому подключение назначения не оставляет следов в вашем проекте Amplitude.

Создание пайплайна

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

Настройка пайплайна

На финальном шаге выберите, что Renta будет писать в Amplitude и какие колонки это заполнят.

Что Renta отправляет

Выберите объект Amplitude и модель данных под него.

1. What would you like Renta to send to Amplitude.
   Выберите, какие данные будет писать этот пайплайн.
2. Data model.
   Выберите модель данных для синхронизации. Колонки, доступные для маппинга ниже, берутся из этой модели.

Маппинг полей

Сопоставьте колонки модели данных со встроенными полями событий Amplitude.

1. Строки маппинга.
   Выберите слева колонку хранилища, справа поле Amplitude, которое она заполняет. Обязательные строки Renta создаёт сама, удалить их нельзя.
2. Add mapping.
   Добавьте строку для каждого поля, которое хотите заполнить дополнительно.

Список справа содержит встроенные поля Amplitude. Ниже они сгруппированы по назначению.

Обязательных полей два:

1. User ID обязателен для обоих объектов.
   Он должен приходить из колонки. Фиксированное значение записало бы все строки синхронизации в один профиль Amplitude, а исправить это позже нельзя: Amplitude не переназначает и не разделяет user ID.
2. Event name обязателен, когда выбран объект Event.
   Замапьте колонку с именем события или задайте Static значение, чтобы отправлять одно постоянное имя для всей синхронизации. Имена $identify и $groupidentify зарезервированы Amplitude, как и всё, что начинается с [Amplitude]. Renta не подставляет собственное имя, поэтому событие всегда приходит с тем, которое задали вы.

Insert ID отвечает за дедупликацию в Amplitude, и маппить его обычно не нужно. Если оставить поле пустым, Renta построит ключ из содержимого строки. Именно поэтому повторный запуск безопасен.

Event properties и user properties

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

1. Event properties.
   Атрибуты самого события, например тариф или сумма. Выберите слева колонку и введите имя свойства, под которым Amplitude его сохранит.
2. User properties.
   Атрибуты, которые хранятся в профиле человека в Amplitude, например статус в CRM. В пайплайне Event они едут вместе с событием, поэтому сразу доступны в отчётах.

Пайплайн Event предлагает оба блока. Пайплайн User profile предлагает только user properties, и как минимум одно свойство обязательно: без него в профиль нечего записывать.

Поведение синхронизации

В блоке Sync behavior задайте, что происходит с удалёнными строками, и назовите пайплайн.

1. When a source row is deleted.
   Доступен только вариант Ignore. Amplitude умеет только добавлять события, поэтому отправленное событие нельзя отозвать.
2. Integration name.
   Имя вашего пайплайна. Измените его по своему усмотрению.

Расписание

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

Для расписания Daily укажите Update time (точное время запуска), затем нажмите Create pipeline.

Новый пайплайн появится в разделе Pipelines на вкладке Reverse ETL, где можно отслеживать его запуски и прогресс.

Стратегия синхронизации

Renta синхронизирует данные инкрементально. Каждый запуск сравнивает модель данных с состоянием, записанным на предыдущем запуске, и отправляет только новые и изменившиеся строки. Поэтому первый запуск доставляет модель целиком.

Каждое событие несёт ключ дедупликации, который Renta вычисляет из содержимого строки, если вы не замапили Insert ID сами. Одинаковое содержимое даёт одинаковый ключ, поэтому повторная доставка после сетевого сбоя не превращается во второе событие в Amplitude. Изменившееся содержимое даёт новый ключ, поэтому обновление всегда доходит.

Лог запуска

Чтобы посмотреть, что отправил запуск, откройте пайплайн, выберите запуск в таблице Runs и раскройте запись в блоке Run actions. Пайплайн Amplitude записывает действие amplitude_partition_delivered на каждый доставленный пакет, и оно несёт ответ Amplitude по этому пакету.

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

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

Лимиты

1. Строки, которые Renta не отправляет.
   Renta отбрасывает строку, у которой User ID пуст, короче пяти символов или заполнен заглушкой, которую Amplitude не принимает: null, none, 0. Остальные строки пакета всё равно уходят в Amplitude, а лог запуска показывает, сколько строк было отброшено.
2. Досрочная остановка запуска.
   Запуск останавливается, когда отклонения превышают 30% одного пакета или 10% всего запуска. Так неправильно замапленная колонка идентификатора не успеет наполнить Amplitude строками, которые не привязаны ни к кому. Следующий запуск продолжит с места остановки.
3. Ключ, который Amplitude отклонил.
   Если API-ключ перестал работать посреди синхронизации, например его перевыпустили в Amplitude, запуск останавливается на первом отклонённом запросе и не отправляет остальные данные ключу, который их не примет. Обновите ключ в назначении, и следующий запуск продолжит с места остановки.
4. Длина значения.
   Amplitude обрезает текстовые значения длиннее 1024 символов. Renta отправляет значение в том виде, в котором оно лежит в хранилище, и не укорачивает его сама.
5. Device ID.
   Renta не предлагает это поле. Amplitude навсегда объединяет двух людей с одинаковым device ID, поэтому повторяющееся или переиспользуемое значение из хранилища склеило бы несвязанные профили в один. Устройство Amplitude определяет сам, по User ID.