RudderStack 集成
RudderStack 是一个客户数据平台,它从您的应用、网站、服务器和数据仓库收集事件,并将其转发到其他工具。借助 RudderStack 中的 Pushwoosh 目的地 (destination),您已在其中收集的数据无需在应用中编写额外代码即可到达 Pushwoosh:
- Track 事件会成为 Pushwoosh 事件。您可以用它们构建细分,以及启动 Customer Journey 或为其创建分支。
- Identify 特征 (traits) 会成为用户专属 (user-specific) 标签。您可以用它们定位和个性化推送通知、应用内消息和电子邮件。
开始之前
Anchor link to该目的地通过 User ID 匹配所有数据,因此请先检查以下前提条件:
- 您的应用中已集成 Pushwoosh SDK。
- 您的应用调用
setUserId时使用的值与 RudderStack 作为userId发送的值相同。Pushwoosh 通过此值将传入的事件和特征关联到用户。 - 在 RudderStack 为某个用户发送
identify调用之前,该用户的设备已使用此 User ID 注册。Pushwoosh 尚不知道的 User ID 的特征会被丢弃。 - 您有权访问 Pushwoosh 中的 Settings → API Access 以创建 API 令牌。
- 您有一个 RudderStack 工作区 (workspace),其中至少有一个发送
track或identify调用的数据源。
在 RudderStack 中设置 Pushwoosh 目的地
Anchor link to设置分为两部分:先在 Pushwoosh 中获取两个值,然后在 RudderStack 中创建目的地。
获取应用代码和 Device API token
Anchor link toRudderStack 需要两个值才能将数据发送到您的应用:应用代码和 Device API token。
- 在 Pushwoosh 中,打开您要发送数据的应用。
- 复制应用代码。它显示在左上角的应用名称下方,格式为
XXXXX-XXXXX。 - 前往 Settings → API Access,点击 Generate New Token。
- 在 Token type 中,选择
device。 - 在 Name 中,输入令牌名称,例如
RudderStack。 - 点击 Generate。
- 在令牌列表中,点击新令牌旁边的三点菜单,选择 Edit token…。
- 在 Applications 下,选择第 1 步中的应用,然后点击 Save。
- 从令牌列表中复制令牌值。
对于该目的地,Device API token 就足够了。您不需要 Server API token。
在 RudderStack 中添加目的地
Anchor link toPushwoosh 目的地会将您的 RudderStack 数据源连接到您的 Pushwoosh 应用。
- 在 RudderStack 控制面板中,前往 Collect → Destinations。
- 点击 New destination。
- 从列表中选择 Pushwoosh。
- 输入目的地名称,然后点击 Continue。
- 选择要发送到 Pushwoosh 的数据源。
- 在 Application Code 中,粘贴应用代码。
- 在 API Token 中,粘贴 Device API token。
- 完成设置以保存目的地。
RudderStack 从其自身的服务器将数据发送到 Pushwoosh(云模式),适用于该目的地支持的所有数据源类型。
有关 RudderStack 端的设置,请参阅 RudderStack 文档中的 Pushwoosh 目的地指南。
RudderStack 向 Pushwoosh 发送哪些数据
Anchor link to该目的地支持两种调用类型:track 和 identify。对于该目的地,RudderStack 会拒绝任何其他调用类型,例如 page、screen、group 或 alias。
每个调用都必须包含 userId。RudderStack 不会发送没有 userId 的调用,因为 Pushwoosh 无法将匿名调用归属到某个用户。
Track 调用会成为 Pushwoosh 事件
Anchor link to每个 track 调用都会成为一个与 RudderStack 事件同名的 Pushwoosh 事件:
| RudderStack 字段 | Pushwoosh |
|---|---|
event | 事件名称 |
properties | 事件属性 |
userId | User ID |
timestamp(或 originalTimestamp) | 事件时间 |
context.device.id | Device ID(如果有) |
context.device.type 或 context.os.name | 平台:android;iOS、iPadOS、watchOS 和 tvOS 为 ios;其他任何值或无值时为 web |
如果应用中尚不存在该事件或某个属性,Pushwoosh 会自动创建。
在以下情况下,Pushwoosh 会丢弃整个事件。由于不会返回错误,RudderStack 会将该事件报告为已送达:
- 调用包含超过 100 个属性 (properties)。
- 某个属性值超过 10 KB。
- 事件名称超过 255 个字符。
- 事件是新事件,且其名称超过 128 个字符或包含控制字符。
一个事件最多保留 100 个属性。当事件已有 100 个已知属性后,Pushwoosh 仍会记录新的调用,但新的属性名称不会被添加为属性。
properties 中的嵌套对象会以 JSON 字符串形式到达,值为 null 的属性会被丢弃。
Identify 调用会成为用户专属标签
Anchor link to每个 identify 调用都会将其特征设置为指定 userId 用户的标签。特征来自 traits;当 traits 为空时,来自 context.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的特征会被丢弃。
该目的地不做什么
Anchor link to该目的地只发送 track 和 identify 数据。以下任务不在其范围内:
- 它不注册设备或电子邮件地址。设备来自 Pushwoosh SDK。
- 它不删除用户。该目的地不支持 RudderStack 的用户删除请求。
检查集成是否正常工作
Anchor link to保存目的地后,从某个数据源发送一个测试 track 调用和一个测试 identify 调用,所用的 userId 需在 Pushwoosh 中已有设备。
- 事件: 在 Pushwoosh 中,前往 Audience → Events,打开该事件,检查其是否已被计数。
- 标签: 前往 Audience → User Explorer,按 User ID 查找用户,检查标签值。
每个调用的送达错误会显示在 RudderStack 中该目的地的 Live Events 视图里。
故障排除
Anchor link to在 Live Events 中找到 RudderStack 针对该目的地显示的错误消息,查看其原因和解决方法。
Track 调用失败并返回 unauthorized
Anchor link toAPI 令牌与应用代码不匹配。请检查该令牌是否与应用属于同一个 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 中检查代码。如果代码正确,请联系您的客户成功经理或支持团队。
调用失败并返回 Missing required value from userId
Anchor link to调用中没有 userId。匿名调用不会发送到 Pushwoosh。请在用户登录后在 RudderStack 数据源中调用 identify,以便后续调用携带 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请按顺序检查以下各项:
- 已在 Pushwoosh 中注册使用此 User ID 的设备。在 Audience → User Explorer 中搜索该用户。
- 应用调用
setUserId时使用的值与 RudderStack 作为userId发送的值完全相同。 - 此名称的标签为 User-specific。针对现有 General 标签的特征会被跳过。请更改标签范围或重命名该特征。
- 特征值与现有标签的类型匹配。
- 该特征不属于永远不会被复制的身份或联系方式特征,例如
email或phone。