Интеграция с Segment

Требуется помощь разработчика

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

Segment — это платформа клиентских данных, которая упрощает сбор данных о пользователях и помогает эффективно их использовать. Если вы храните свои клиентские данные в Segment, вы можете настроить интеграцию с Pushwoosh всего за несколько кликов.

После настройки интеграции Segment будет отправлять в Pushwoosh следующие данные:

• Атрибуты пользователя: имя, устройство, предпочтения, местоположение, поведение и т.д. Pushwoosh сохранит эти данные как теги (Tags) и их значения для каждого пользователя.
• События: каждое событие Segment будет передано в Pushwoosh и сохранено как событие Pushwoosh с тем же именем. Pushwoosh также получит информацию о том, какие события вызвал каждый пользователь.

Используя данные из Segment, вы можете взаимодействовать со своей аудиторией с помощью бесшовных коммуникаций в Pushwoosh. Ниже приведены два примера использования возможностей обеих платформ:

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

Например, Segment отправляет в Pushwoosh данные о событии SubscribedToOffers. Вы можете создать в Pushwoosh сегмент пользователей, состоящий из тех, кто подписался на специальные предложения:

Затем вы можете создавать увлекательные Customer Journeys с промо-сообщениями и скидками для пользователей, которые подписались на ваши предложения:

2. Персонализируйте сообщения на основе атрибутов пользователей из Segment. Вы можете использовать атрибуты пользователей, полученные из Segment, для изменения контента ваших пуш-уведомлений, сообщений в приложении и email-сообщений. Это позволит вам настраивать релевантные и высококонверсионные коммуникации.

Например, Segment отправляет в Pushwoosh значения атрибута searched_product. Вы можете создать пресет пуш-уведомления, предлагающий скидку на товары из категории, которую пользователь ранее искал:

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

Обзор интеграции

Тип интеграции

• Destination: данные отправляются из Segment в Pushwoosh.
• Source: данные отправляются из Pushwoosh в Segment.

Предварительные требования

Платные аккаунты в Pushwoosh и Segment.

Синхронизируемые сущности

Source

• Статистика пуш-уведомлений

Destination

• Устройства
• Теги (Tags)

Сценарии использования

Отслеживание уведомлений

Отправляйте пуш-уведомления и отслеживайте их статус, включая успешную отправку и доставку.

Анализ событий

Анализируйте события, инициированные пользователями, такие как доставка пуш-уведомлений или email-сообщений, и убедитесь, что эти события точно записываются в Segment.

Управление пользователями

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

Настройка интеграции

Примечание

Перед настройкой интеграции с Segment убедитесь, что вы интегрировали Pushwoosh SDK.

Настройка Destination

1. В интерфейсе Segment перейдите в Connections → Destinations и нажмите Add Destination.

2. Найдите Pushwoosh и выберите его.

3. Выберите Sources, к которым вы хотите подключить Destination.

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

5. Введите API-ключ Pushwoosh и код приложения. Убедитесь, что переключатель Enable Destination включен. После этого нажмите Save Changes.

Где найти API-ключ и код приложения?

API-ключ можно найти в разделе Settings → API Access:

Код приложения можно найти в левом верхнем углу интерфейса Pushwoosh, прямо под названием проекта:

6. Перейдите на вкладку Mappings и убедитесь, что опции Create or Update User Profile и Track Events включены:

Важно проверить сопоставление полей событий из вашего источника с Pushwoosh в качестве Destination, чтобы убедиться, что ваши события обрабатываются корректно.

Если событие не содержит поле device_platform или это поле неверно, ваше событие будет проигнорировано. Кроме того, если событие не содержит ни userId, ни deviceId, оно также будет проигнорировано.

Чтобы убедиться, что ваше сопоставление настроено правильно, перейдите в Pushwoosh as Destination > Settings.

Затем выберите вкладку Mapping и нажмите Edit Mapping для метода Track Events.

Далее убедитесь, что сопоставление ваших событий с событиями, отправляемыми в Pushwoosh, корректно, и что поля Device Platform и External User ID (или Device ID) правильно сопоставлены.

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

Если интеграция настроена правильно, Pushwoosh начнет получать события и атрибуты пользователей из Segment. На основе этих данных вы можете создавать высокотаргетированные Customer Journeys и персонализировать свои пуш-уведомления, сообщения в приложении и email-сообщения.

Настройка Source

1. На странице каталога Sources вашего рабочего пространства нажмите Add Source.
2. Найдите “Pushwoosh” в каталоге Sources, выберите Pushwoosh и нажмите Add Source.
3. На следующем экране дайте источнику имя и настройте любые другие параметры.

Примечание

Имя используется как метка в приложении Segment, и Segment создает соответствующее имя схемы в вашем хранилище. Имя может быть любым, но Pushwoosh рекомендует использовать что-то, что отражает сам источник и различает ваши среды (например: Pushwoosh_Prod, Pushwoosh_Staging, Pushwoosh_Dev).

4. Нажмите Add Source, чтобы сохранить настройки.
5. Скопируйте Write key из интерфейса Segment.
6. Войдите в свой аккаунт Pushwoosh и выберите приложение, которое хотите подключить.
7. Перейдите в Settings > 3rd party integration > Segment, нажмите кнопку Configure и введите ваш Write key из рабочего пространства Segment.
8. Перечислите события, которые вы хотите экспортировать, используя разделитель , в поле Events, или оставьте его пустым, если хотите экспортировать все события, затем нажмите Apply.

Поток (Stream)

Pushwoosh использует компонент Segment stream Source для отправки данных о событиях в Segment. Он использует серверный метод track для отправки данных в Segment. Эти события затем доступны в любом Destination, который принимает серверные события, и доступны в схеме вашего хранилища данных.

По умолчанию Pushwoosh передает User ID из Pushwoosh как свойство userId в Segment. Если связанного User ID нет, Pushwoosh передаст HWID как anonymousId в Segment.

События

В таблице ниже перечислены события, которые Pushwoosh отправляет в Segment. Эти события отображаются как таблицы в вашем хранилище и как обычные события в других Destinations.

Название события	Описание
Email Sent	Email успешно отправлен
Push Sent	Пуш-уведомление успешно отправлено
SMS Sent	SMS отправлено получателю
Push Opened	Пуш-уведомление было открыто
Email Opened	Email-уведомление было открыто
Email Delivered	Email успешно доставлен
Push Delivered	Пуш-уведомление успешно доставлено
SMS Delivered	SMS успешно доставлено
SMS Not Delivered	Доставка SMS не удалась
Email Bounced	Email возвращен отправителю из-за постоянной ошибки
Email Unsubscribed	Пользователь перешел по ссылке отписки в email

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

В таблице ниже перечислены свойства, включенные в вышеуказанные события.

Название свойства	Описание
message_type	Содержит тип сообщения (Push, Email, In-App или SMS)
campaign_code	Уникальный идентификатор кампании сообщения
device_type	Тип устройства

Добавление Destinations

Теперь, когда ваш Source настроен, вы можете подключить его к Destinations.

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

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

Как работает интеграция

1. Инициация пуш-уведомления: клиент начинает процесс, инициируя пуш-уведомление через интерфейс Pushwoosh.
2. Создание события: бэкенд Pushwoosh обрабатывает запрос на пуш-уведомление и генерирует событие. Это событие затем отправляется в топик Kafka с именем channels-tracking-log, управляемый Pushwoosh.
3. Потребление события: сервис интеграции с Segment постоянно слушает топик Kafka channels-tracking-log и потребляет события по мере их поступления.
4. Обработка события: потребленные события обрабатываются сервисом интеграции с Segment, который преобразует их в события Segment Track Events.
5. Передача события: обработанные события Segment Track Events затем отправляются на бэкенд Segment для дальнейшей обработки и анализа.

Как узнать, что интеграция работает?

Destination

track-user

Перейдите в ваш аккаунт Pushwoosh > Ваше подключенное приложение > Audience > User Explorer. Найдите вашего пользователя/устройство и проверьте теги, которые отправил Segment.

post-event

Перейдите в ваш аккаунт Pushwoosh > Ваше подключенное приложение > Audience > Events. Выберите событие, нажмите на меню с тремя точками и выберите Event Statistics. Убедитесь, что событие подсчитано.

delete-user

Перейдите в ваш аккаунт PW > Ваше подключенное приложение > Audience > User Explorer. Убедитесь, что пользователь/устройство не существует.

Source

Используйте отладчик Source, чтобы обнаружить события, которые были отправлены из Pushwoosh в Segment.

Устранение неполадок

Проверка статуса интеграции

Для устранения проблем с интеграцией Pushwoosh начните с проверки следующего:

Destination

• Track-User: проверьте информацию о пользователе/устройстве и теги в Pushwoosh в разделе Audience > User Explorer.
• Post-Event: убедитесь, что событие подсчитано в Pushwoosh, проверив статистику событий.
• Delete-User: подтвердите, что пользователь/устройство больше не существует в Pushwoosh.

Source

Используйте отладчик источника на Segment Debugger, чтобы проверить, правильно ли отправляются события из Pushwoosh в Segment.

Несоответствие событий

Если события не отображаются корректно в Segment, убедитесь, что события Pushwoosh правильно сопоставлены с событиями Segment Track Events в соответствии с предоставленными правилами сопоставления.

Проблемы с аутентификацией

Убедитесь, что в запросах к Pushwoosh и Segment используются правильные токены аутентификации или API-ключи.

Проблемы с потоком данных

Убедитесь, что поток данных между Pushwoosh и Segment не прерывается и что топики Kafka отслеживаются корректно.

Часто задаваемые вопросы (FAQ)

Какие типы событий отправляются из Pushwoosh в Segment?

В Segment отправляются зарезервированные события, такие как Push Sent, Email Sent, SMS Sent, Push Delivered, Email Delivered, SMS Delivered и Email Bounced.

Как я могу проверить, что события корректно отправляются в Segment?

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

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

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

Как обрабатывается информация о пользователях и устройствах в интеграции?

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

Где я могу найти подробную документацию по интеграции?

Подробная документация доступна в руководствах по интеграции Segment и Pushwoosh, а также в их соответствующей API-документации.