コンテンツにスキップ

イベントスキーマ

CRMイベントのエクスポートで蓄積される FlareLane CRM イベントのスキーマです。

カラム区分説明
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.sentProvider に正常に受付された
sms.aborted配信中止(頻度制限/受信拒否/Liquid など)
sms.failedProvider 受付失敗
sms.delivered受信端末への到達完了 (Provider コールバックに基づく)
sms.undelivered受信端末への到達失敗 (Provider コールバックに基づく)

Kakaoアルリムトーク (channel=kakaoalimtalk)

Section titled “Kakaoアルリムトーク (channel=kakaoalimtalk)”
type説明
kakaoalimtalk.createdアルリムトーク配信リクエスト生成 (Provider 呼び出し前)
kakaoalimtalk.sentProvider に正常に受付された
kakaoalimtalk.aborted配信中止(頻度制限/受信拒否/Liquid など)
kakaoalimtalk.failedProvider 受付失敗
kakaoalimtalk.delivered受信端末への到達完了 (Provider コールバックに基づく)
kakaoalimtalk.undelivered受信端末への到達失敗 (Provider コールバックに基づく)

Kakaoブランドメッセージ (channel=kakaobrandmessage)

Section titled “Kakaoブランドメッセージ (channel=kakaobrandmessage)”
type説明
kakaobrandmessage.createdブランドメッセージ配信リクエスト生成 (Provider 呼び出し前)
kakaobrandmessage.sentProvider に正常に受付された
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(アプリ内メッセージはこの 2 つのみ使用)
journey_*optional自動化コンテキスト
platformoptional端末プラットフォーム。SDK イベント時のみ埋められる(iam.created では null)
iam_clickable_idoptionalCTA ボタン識別子。iam.clicked 専用
iam_dont_show_minutesoptional「今後表示しない」の分単位の値。iam.closed 専用。0/null なら単純な閉じる、正の値なら N 分間非表示

顧客イベント(カスタムトラッキングイベント)はスキーマレスな data 属性を持ち、crm_events とは別のパイプラインで蓄積されます。

フィールド必須説明
idstringrequiredイベント固有の識別子 (ULID)
typestringrequiredイベントタイプ
timestringrequiredイベント発生時刻 (RFC 3339, UTC)
projectidstringrequiredFlareLane プロジェクト識別子
useridstringoptionalFlareLane ユーザー識別子(未識別ユーザーの場合は null)
deviceidstringoptionalFlareLane デバイス識別子
datastringoptionalイベント発行時に併せて渡したカスタム属性オブジェクト。キー・値・型を自由に定義するスキーマレスな値で、シリアライズ(stringify)して単一の string カラムに保存。
platformstringoptional端末プラットフォーム。android / ios / webDesktop / webMobile