Перейти к содержанию

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

RudderStack — это платформа клиентских данных (CDP), которая собирает события из ваших приложений, сайтов, серверов и хранилищ данных и передает их в другие инструменты. С destination Pushwoosh в RudderStack данные, которые вы уже там собираете, попадают в Pushwoosh без дополнительного кода в приложении:

  • Track-события становятся событиями Pushwoosh. Используйте их, чтобы строить сегменты, а также запускать джорни или ветвить их.
  • Identify-трейты становятся пользовательскими (user-specific) тегами. Используйте их для таргетинга и персонализации push-уведомлений, In-App сообщений и email.

Перед началом работы

Anchor link to

Destination сопоставляет все данные по User ID, поэтому сначала проверьте следующие условия:

  • Pushwoosh SDK интегрирован в ваше приложение.
  • Ваше приложение вызывает setUserId с тем же значением, которое RudderStack отправляет как userId. Pushwoosh связывает входящие события и трейты с пользователями по этому значению.
  • Устройство каждого пользователя зарегистрировано с этим User ID до того, как RudderStack отправит вызовы identify для этого пользователя. Трейты для User ID, который Pushwoosh еще не знает, отбрасываются.
  • У вас есть доступ к Settings → API Access в Pushwoosh, чтобы создать API-токен.
  • У вас есть рабочее пространство (workspace) RudderStack хотя бы с одним источником, который отправляет вызовы track или identify.

Настройка destination Pushwoosh в RudderStack

Anchor link to

Настройка состоит из двух частей: вы получаете два значения в Pushwoosh, а затем создаете destination в RudderStack.

Получите код приложения и Device API token

Anchor link to

RudderStack нужны два значения, чтобы отправлять данные в ваше приложение: код приложения и Device API token.

  1. В Pushwoosh откройте приложение, в которое хотите отправлять данные.
  2. Скопируйте код приложения. Он отображается под названием приложения в левом верхнем углу и выглядит как XXXXX-XXXXX.
  3. Перейдите в Settings → API Access и нажмите Generate New Token.
  4. В поле Token type выберите device.
  5. В поле Name введите название токена, например RudderStack.
  6. Нажмите Generate.
  7. В списке токенов нажмите на меню с тремя точками рядом с новым токеном и выберите Edit token….
  8. В разделе Applications выберите приложение из шага 1 и нажмите Save.
  9. Скопируйте значение токена из списка токенов.

Для destination достаточно Device API token. Server API token не нужен.

Добавьте destination в RudderStack

Anchor link to

Destination Pushwoosh подключает ваши источники RudderStack к вашему приложению Pushwoosh.

  1. В дашборде RudderStack перейдите в Collect → Destinations.
  2. Нажмите New destination.
  3. Выберите Pushwoosh в списке.
  4. Введите название destination и нажмите Continue.
  5. Выберите источники, данные которых хотите отправлять в Pushwoosh.
  6. В поле Application Code вставьте код приложения.
  7. В поле API Token вставьте Device API token.
  8. Завершите настройку, чтобы сохранить destination.

RudderStack отправляет данные в Pushwoosh со своих серверов (cloud mode) для каждого типа источника, который поддерживает destination.

О настройке на стороне RudderStack читайте в руководстве по destination Pushwoosh в документации RudderStack.

Какие данные RudderStack отправляет в Pushwoosh

Anchor link to

Destination поддерживает два типа вызовов: track и identify. Любой другой тип вызова, например page, screen, group или alias, RudderStack для этого destination отклоняет.

У каждого вызова должен быть userId. RudderStack не отправляет вызовы без него, потому что Pushwoosh не может привязать анонимный вызов к пользователю.

Вызовы track становятся событиями Pushwoosh

Anchor link to

Каждый вызов track становится событием Pushwoosh с тем же названием, что и событие RudderStack:

Поле RudderStackPushwoosh
eventНазвание события
propertiesАтрибуты события
userIdUser ID
timestamp (или originalTimestamp)Время события
context.device.idDevice ID, если есть
context.device.type или context.os.nameПлатформа: android; ios для iOS, iPadOS, watchOS и tvOS; web для любого другого значения или при отсутствии значения

Если события или атрибута еще нет в приложении, Pushwoosh создает их автоматически.

В следующих случаях Pushwoosh отбрасывает событие целиком. Ошибка при этом не возвращается, поэтому RudderStack показывает событие как доставленное:

  • У вызова больше 100 свойств.
  • Значение свойства длиннее 10 КБ.
  • Название события длиннее 255 символов.
  • Событие новое, и его название длиннее 128 символов или содержит управляющие символы.

У события может быть до 100 атрибутов. Когда у события уже 100 известных атрибутов, Pushwoosh продолжает записывать новые вызовы, но новые названия свойств не добавляются как атрибуты.

Вложенные объекты в properties приходят как JSON-строки, а свойства со значением null отбрасываются.

Вызовы identify становятся пользовательскими тегами

Anchor link to

Каждый вызов identify записывает свои трейты как теги пользователю с указанным userId. Трейты берутся из traits или из context.traits, если traits пуст.

  • Записываются только пользовательские теги. Если для вашего аккаунта включено автоматическое создание тегов, трейт с новым названием создает пользовательский тег. Если тег General с таким же названием уже существует, Pushwoosh пропускает этот трейт без ошибки.
  • Значение должно соответствовать типу тега. Если тег уже существует, а значение трейта не подходит под его тип, например текст для тега типа Integer, Pushwoosh пропускает этот трейт без ошибки.
  • Пользователь должен уже существовать в Pushwoosh. Теги применяются, только если Pushwoosh SDK зарегистрировал устройство, у которого setUserId задан тем же userId. Трейты для неизвестного пользователя отбрасываются без ошибки.
  • Идентификационные и контактные трейты не копируются в теги. email, phone, firstName, lastName, name, address, id, userId и anonymousId никогда не отправляются как теги. Вызов identify, в котором есть только эти трейты, завершается ошибкой No traits left to send as Pushwoosh tags.
  • Пустое значение очищает тег. Трейт с пустой строкой или пустым списком удаляет текущее значение этого тега у пользователя.
  • Вложенные объекты приходят как JSON-строки. Трейты со значением null отбрасываются.

Чего destination не делает

Anchor link to

Destination отправляет только данные track и identify. Следующие задачи остаются за его пределами:

  • Он не регистрирует устройства и email-адреса. Устройства регистрирует Pushwoosh SDK.
  • Он не удаляет пользователей. Запросы RudderStack на удаление пользователей для этого destination не поддерживаются.

Проверьте, что интеграция работает

Anchor link to

После сохранения destination отправьте тестовые вызовы track и identify из источника с userId, у которого уже есть устройство в Pushwoosh.

  • События: в Pushwoosh перейдите в Audience → Events, откройте событие и убедитесь, что оно учтено.
  • Теги: перейдите в Audience → User Explorer, найдите пользователя по User ID и проверьте значения тегов.

Ошибки доставки для каждого вызова отображаются в разделе Live Events этого destination в RudderStack.

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

Anchor link to

Найдите сообщение об ошибке, которое RudderStack показывает для destination в Live Events, чтобы узнать причину и способ исправления.

Вызовы track завершаются ошибкой unauthorized

Anchor link to

API-токен не соответствует коду приложения. Проверьте, что токен принадлежит тому же аккаунту Pushwoosh, что и приложение.

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

Вызовы завершаются ошибкой application not found или application code is not valid

Anchor link to

Код приложения неверен, или аккаунт размещен не на app.pushwoosh.com. Вызовы track завершаются ошибкой application not found, а вызовы identify — ошибкой application code is not valid. Проверьте код в Pushwoosh Control Panel. Если код верный, обратитесь к вашему Customer Success Manager или в поддержку.

Вызовы завершаются ошибкой Missing required value from userId

Anchor link to

У вызова нет userId. Анонимные вызовы не отправляются в Pushwoosh. Вызывайте identify в источнике RudderStack после входа пользователя, чтобы последующие вызовы содержали userId.

Вызовы завершаются ошибкой Invalid enum value

Anchor link to

Тип вызова не track и не identify. Pushwoosh принимает только эти два типа. Либо не подключайте источники, которые отправляют только вызовы page, screen, group или alias, либо игнорируйте эти ошибки.

Вызовы identify завершаются ошибкой No traits left to send as Pushwoosh tags

Anchor link to

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

Вызовы identify выполняются успешно, но теги не появляются

Anchor link to

Проверьте по порядку:

  1. Устройство с этим User ID зарегистрировано в Pushwoosh. Найдите пользователя в Audience → User Explorer.
  2. Приложение вызывает setUserId точно с тем же значением, которое RudderStack отправляет как userId.
  3. Тег с этим названием имеет область User-specific. Трейт для существующего тега General пропускается. Измените область тега или переименуйте трейт.
  4. Значение трейта соответствует типу существующего тега.
  5. Трейт не относится к идентификационным или контактным трейтам, которые никогда не копируются, например email или phone.