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

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

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

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

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

• Атрибуты пользователя: имя, устройство, предпочтения, местоположение, поведение и т.д. Pushwoosh сохранит эти данные как теги и их значения для каждого пользователя.
• События: каждое событие 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

• События статистики пуш-уведомлений, email и SMS

Destination

• Устройства
• Теги
• События
• Удаление пользователей

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

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

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

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

Анализируйте события, инициированные пользователями, такие как доставка пуш-уведомлений или 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 в качестве назначения, чтобы убедиться, что ваши события обрабатываются правильно.

Поле device_platform принимает значения ios, android или web. События с любым другим значением Pushwoosh пропускает. Pushwoosh также отклоняет событие, в котором нет ни 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.

Что Pushwoosh делает с данными из Segment

• Create or Update User Profile: Pushwoosh сохраняет атрибуты пользователя (traits) как теги и автоматически создает отсутствующие теги.
  • Если в запросе есть email, Pushwoosh регистрирует для пользователя email-устройство и сохраняет атрибуты на нем.
  • Для push-устройства в запросе нужны токен устройства, ID устройства и device_platform со значением ios, android или web. Без них атрибуты не сохраняются на push-устройстве.
  • Атрибуты, названные так же, как теги Pushwoosh по умолчанию, например Language, Country или Timezone, игнорируются, как и атрибуты, значение которых — объект.
• Track Events: Pushwoosh записывает каждое событие под его именем в Segment и автоматически создает отсутствующие события и атрибуты.
• Удаление пользователей: Pushwoosh удаляет все устройства пользователя с указанным внешним ID пользователя (external_id). Поле external_id обязательно. Запрос без него получает ответ 400 и ничего не удаляет.

Если Pushwoosh временно не может обработать события, он отвечает статусом 503, чтобы Segment мог повторить доставку. События, которые Pushwoosh отклоняет из-за их содержимого, например из-за неподдерживаемого device_platform или отсутствия ID пользователя и ID устройства, получают ответ 200 и повторно не отправляются.

Конфигурация Source

1. На странице каталога источников (Sources) вашего рабочего пространства Sources catalog page нажмите Add Source.
2. Найдите “Pushwoosh” в каталоге источников, выберите 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. В поле События выберите события, которые хотите экспортировать, затем нажмите Применить. Pushwoosh экспортирует только выбранные события, поэтому интеграцию нельзя сохранить, не выбрав хотя бы одно.

Поток (Stream)

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

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

События

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

Название события	Описание
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 или sms. Отсутствует, если канал неизвестен
campaign_code	Код кампании, к которой относится сообщение. Есть только у сообщений, отправленных из кампании
device_type	Код платформы устройства в Pushwoosh, число. Значения device_type см. в /registerDevice

Добавление назначений (Destinations)

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

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

Если возникнут какие-либо проблемы с тем, как события поступают в 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 debugger), чтобы обнаружить события, которые были отправлены из Pushwoosh в Segment.

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

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

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

Destination

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

Source

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

Пользователи не удаляются

Проверьте, что запрос на удаление содержит поле external_id с ID пользователя. Без него Pushwoosh отвечает статусом 400 и ничего не удаляет.

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

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

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

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

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

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

FAQ

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

Pushwoosh отправляет события, которые вы выбрали в настройках интеграции: Push Sent, Push Delivered, Push Opened, Email Sent, Email Delivered, Email Opened, Email Bounced, Email Unsubscribed, SMS Sent, SMS Delivered и SMS Not Delivered.

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

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

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

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

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

Pushwoosh регистрирует или обновляет устройство и сохраняет атрибуты пользователя (traits) как теги. Отсутствующие теги создаются автоматически. Атрибуты, названные так же, как теги Pushwoosh по умолчанию, например Language или Country, игнорируются.

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

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