跳转到内容

事件 schema

通过导出 CRM 事件写入的 FlareLane CRM 事件的 schema。

类型类别说明
idstring通用事件唯一标识符 (ULID)
typestring通用事件类型。例:push.sent
channelstring通用渠道判别符。push / sms / kakaoalimtalk / kakaobrandmessage / email / iam
timestring通用事件发生时刻 (RFC 3339, UTC)
deviceidstring通用FlareLane 设备标识符
useridstring通用FlareLane 用户标识符(未识别用户时为 null)
campaign_idstring共享营销活动标识符
campaign_namestring共享营销活动名称
trigger_typestring共享发送触发器。api / console / test / journey / recurring / system
journey_idstring共享自动化标识符
journey_namestring共享自动化名称
journey_step_idstring共享自动化动作标识符
journey_enrollment_idstring共享自动化执行标识符
recurring_message_idstring共享重复发送消息标识符
senderstring共享发件方。SMS=发送号码,Email=发件邮箱
recipientstring共享收件方。SMS/Kakao=接收号码,Email=收件邮箱
subjectstring共享标题。push/sms/email=标题,通知消息=强调标记型标题,品牌消息=页眉
bodystring共享正文(interpolation 之前的原文)。Email 不包含
template_idstring共享模板标识符 (push / kakaoalimtalk / email)
template_namestring共享模板名称 (push / kakaoalimtalk / email)
providerstring共享推送提供商。fcm / apns / webpush仅限 Push
provider_message_idstring共享提供商侧消息 ID(仅限 Push
provider_errorstring共享提供商侧错误消息(仅限 Push
errorstring共享错误/失败原因(failed·undelivered·aborted 时)
platformstring共享终端平台。android / ios / webDesktop / webMobile
message_typestring共享消息类型。SMS=SMS/LMS/MMS,Kakao=消息类型
is_advertisementboolean共享是否为广告(SMS / 品牌消息)
kakaoalimtalk_template_codestring渠道专有Kakao 审核模板代码(仅限通知消息
kakao_sender_keystring渠道专有Kakao 发送配置文件(渠道)密钥(仅限品牌消息
iam_groupstring渠道专有应用内分组/分类(仅限 InAppMessage
iam_clickable_idstring渠道专有CTA 按钮标识符(仅限 iam.clicked
iam_dont_show_minutesint渠道专有"不再显示"的分钟数值(仅限 iam.closed)。为 0/null 时表示单纯关闭,为正数时表示 N 分钟内不显示
projectidstring分区FlareLane 项目标识符
datestring分区time 派生的 YYYY-MM-DD (UTC)

channel 值为 push / sms / kakaoalimtalk / kakaobrandmessage / email / iam 之一。

  • *.created:发送请求已创建
  • *.sent:Provider 正常受理
  • *.aborted:因频率限制 / 拒收 / Liquid 中断等策略·条件原因而未发送。原因记录在 error
  • *.failed:因 Provider 错误而发送失败
  • *.delivered/*.undelivered:接收终端送达成功/失败
type说明
push.created推送发送请求已创建(PNS 调用前)
push.sent推送发送成功(PNS 正常响应)
push.aborted推送发送中止(频率限制/拒收/Liquid 等)
push.failed推送发送失败(provider/技术错误)
push.clicked用户点击了推送
type说明
sms.createdSMS 发送请求已创建(Provider 调用前)
sms.sent已被 Provider 正常受理
sms.aborted发送中止(频率限制/拒收/Liquid 等)
sms.failedProvider 受理失败
sms.delivered已送达至接收终端(基于 Provider 回调)
sms.undelivered接收终端送达失败(基于 Provider 回调)

Kakao 通知消息 (channel=kakaoalimtalk)

Section titled “Kakao 通知消息 (channel=kakaoalimtalk)”
type说明
kakaoalimtalk.created通知消息发送请求已创建(Provider 调用前)
kakaoalimtalk.sent已被 Provider 正常受理
kakaoalimtalk.aborted发送中止(频率限制/拒收/Liquid 等)
kakaoalimtalk.failedProvider 受理失败
kakaoalimtalk.delivered已送达至接收终端(基于 Provider 回调)
kakaoalimtalk.undelivered接收终端送达失败(基于 Provider 回调)

Kakao 品牌消息 (channel=kakaobrandmessage)

Section titled “Kakao 品牌消息 (channel=kakaobrandmessage)”
type说明
kakaobrandmessage.created品牌消息发送请求已创建(Provider 调用前)
kakaobrandmessage.sent已被 Provider 正常受理
kakaobrandmessage.aborted发送中止(频率限制/拒收/Liquid 等)
kakaobrandmessage.failedProvider 受理失败
kakaobrandmessage.delivered已送达至接收终端(基于 Provider 回调)
kakaobrandmessage.undelivered接收终端送达失败(基于 Provider 回调)
type说明
email.created邮件发送请求已创建
email.sentProvider 受理完成
email.delivered已送达至接收邮件服务器
email.failedProvider 受理失败
email.aborted发送中止(频率限制/拒收/Liquid 等)
email.complaint发生垃圾邮件举报
email.opened收件人打开了邮件
email.clicked收件人点击了邮件内的链接
type说明
iam.created应用内消息展示请求已创建(服务器侧)
iam.displayed应用内消息在用户终端上展示(SDK 事件)
iam.clicked用户点击了应用内 CTA 按钮(SDK 事件)
iam.closed用户关闭了应用内消息(SDK 事件)

各渠道填充的列及其含义。表中未列出的列在该渠道中始终为 null

必填说明
campaign_idrequired营销活动标识符
campaign_nameoptional营销活动名称
template_idoptional模板标识符
template_nameoptional模板名称
subjectoptional推送标题(interpolation 之前的原文)
bodyoptional推送正文(interpolation 之前的原文)
trigger_typeoptionalapi / console / test / journey 等
journey_*optional自动化上下文
recurring_message_idoptional重复发送消息标识符
platformrequired终端平台
provideroptional推送提供商 (fcm / apns / webpush)
provider_message_idoptional提供商侧消息 ID
provider_erroroptional提供商侧错误消息
erroroptional错误/失败原因
必填说明
campaign_idrequired营销活动标识符
campaign_nameoptional营销活动名称
message_typerequired消息类型。SMS / LMS / MMS
subjectoptionalLMS/MMS 标题
bodyrequired正文(interpolation 之前的原文)
senderrequired发送号码
recipientoptional接收号码
is_advertisementrequired是否为广告
trigger_typeoptional发送触发器
journey_*optional自动化上下文
recurring_message_idoptional重复发送消息标识符
platformoptional终端/发送平台
erroroptional错误/失败原因
必填说明
campaign_idrequired营销活动标识符
campaign_nameoptional营销活动名称
template_idrequiredFlareLane 内部模板标识符
kakaoalimtalk_template_coderequiredKakao 审核模板代码
template_nameoptional模板名称
subjectoptional强调标记型标题
bodyrequired正文(interpolation 之前的原文)
recipientrequired接收号码
message_typerequired消息类型
trigger_typeoptional发送触发器
journey_*optional自动化上下文
recurring_message_idoptional重复发送消息标识符
platformoptional终端/发送平台
erroroptional错误/失败原因
必填说明
campaign_idrequired营销活动标识符
campaign_nameoptional营销活动名称
kakao_sender_keyoptionalKakao 发送配置文件(渠道)密钥
bodyrequired正文(interpolation 之前的原文)
subjectoptional消息页眉
recipientrequired接收号码
message_typerequired消息类型
is_advertisementoptional是否为广告
trigger_typeoptional发送触发器
journey_*optional自动化上下文
recurring_message_idoptional重复发送消息标识符
platformoptional终端/发送平台
erroroptional错误/失败原因
必填说明
campaign_idrequired营销活动标识符
campaign_nameoptional营销活动名称
template_idrequired模板标识符
template_nameoptional模板名称
subjectoptional邮件标题
senderrequired发件邮箱地址
recipientoptional收件邮箱地址
trigger_typeoptional发送触发器
journey_*optional自动化上下文
recurring_message_idoptional重复发送消息标识符
platformoptional终端/发送平台
erroroptional错误/失败原因
必填说明
campaign_idrequired营销活动标识符
campaign_nameoptional营销活动名称
iam_grouprequired应用内分组/分类
trigger_typeoptionalconsole / journey(应用内仅使用这两种)
journey_*optional自动化上下文
platformoptional终端平台。仅在 SDK 事件时填充(iam.created 中为 null)
iam_clickable_idoptionalCTA 按钮标识符。仅限 iam.clicked
iam_dont_show_minutesoptional"不再显示"的分钟数值。仅限 iam.closed。为 0/null 时表示单纯关闭,为正数时表示 N 分钟内不显示

客户事件(自定义跟踪事件)具有无 schema 的 data 属性,并与 crm_events 采用独立管道写入。

字段类型必填说明
idstringrequired事件唯一标识符 (ULID)
typestringrequired事件类型
timestringrequired事件发生时刻 (RFC 3339, UTC)
projectidstringrequiredFlareLane 项目标识符
useridstringoptionalFlareLane 用户标识符(未识别用户时为 null)
deviceidstringoptionalFlareLane 设备标识符
datastringoptional事件发布时一并传入的自定义属性对象。键·值·类型可自由定义的无 schema 值,经序列化(stringify)后存储为单个 string 列。
platformstringoptional终端平台。android / ios / webDesktop / webMobile