メインコンテンツへスキップ
Liquid構文を使用してイベントストリームデータにアクセスします。任意のフィールドを {{ }} でラップしてイベントストリームボディに含めます。例を参照してください。
JourneysおよびAPIによるメッセージデータは30日間保持されます。30日後に発生したインタラクションイベント（クリック、開封、配信停止）はメッセージプロパティが空白になる場合があります。データを復元するには、インタラクションイベントの message.id を元の sent イベント（完全なメッセージデータを含む）と照合してください。

​
eventプロパティ

すべてのイベントには以下のコアフィールドが含まれます。event.data.* のチャネル固有フィールドは適用可能な場合のみ含まれます — チャネル固有フィールドを参照してください。
​
event.kind
string
チャネルとアクションを組み合わせたイベントタイプ（例：message.push.clicked、message.email.bounced）。値の完全なリストは以下のイベントカインドリファレンスを参照してください。Liquid： {{ event.kind }}
​
event.id
UUID
UUID v4形式の各個別イベントに対するOneSignal生成の一意の識別子。このIDを冪等配信追跡に使用します。メッセージまたはテンプレート識別子には、message.id または message.template_id を使用してください。Liquid： {{ event.id }}
​
event.timestamp
integer
イベントのUNIXタイムスタンプ。Liquid： {{ event.timestamp }}
​
event.datetime
string
ISO 8601文字列としてUTCで表示したイベントの人間が読める時刻（例：“2024-02-21T23:45:15.228Z”）。Liquid： {{ event.datetime }}
​
event.app_id
UUID
OneSignal App ID。Liquid： {{ event.app_id }}
​
event.subscription_device_type
string
サブスクリプションタイプ（例：iOS、Android、Chrome、Email、SMS）。Liquid： {{ event.subscription_device_type }}
​
event.subscription_id
UUID
OneSignal Subscription ID。Liquid： {{ event.subscription_id }}
​
event.onesignal_id
UUID
OneSignal User ID。Liquid： {{ event.onesignal_id }}
​
event.external_id
string
OneSignal External ID エイリアスとして設定されたユーザーID。設定されていない場合は空になることがあります。Liquid： {{ event.external_id }}

​
チャネル固有フィールド

これらの event.data.* フィールドは特定のイベントカインドにのみ存在します。

​
アプリ内メッセージイベント

message.iam.* イベントに含まれます。詳細についてはアプリ内メッセージイベントストリームを参照してください。
​
event.data.page_name
string
表示されたアプリ内メッセージページまたはカードの名称。Liquid： {{ event.data.page_name }}
​
event.data.page_id
string
表示されたアプリ内メッセージページまたはカードの一意の識別子。Liquid： {{ event.data.page_id }}
​
event.data.target_name
string
クリックされたボタンまたは画像ブロック要素の名称。要素にはアプリ内クリックアクションが含まれている必要があります。Liquid： {{ event.data.target_name }}
​
event.data.target_id
string
クリックされたボタンまたは画像ブロック要素の一意の識別子。Liquid： {{ event.data.target_id }}

​
Live Activityイベント

message.live_activity.* イベントに含まれます。
​
event.data.live_activity_id
string
特定のLive Activityの一意の識別子（例：“Knicks vs Cavs - Oct 22 7PM”）。Liquid： {{ event.data.live_activity_id }}
​
event.data.live_activity_type
string
Live Activityカテゴリのグループ化ラベル（例：“Knicks_games”）。Liquid： {{ event.data.live_activity_type }}

​
失敗イベント

message.push.failed と message.email.failed イベントに含まれます。
​
event.data.failure_reason
string
メッセージの送信が失敗した理由。一般的な理由についてはプッシュメッセージレポートまたはメールメッセージレポートを参照してください。Liquid： {{ event.data.failure_reason }}

​
イベントカインドリファレンス

各指標の詳細な定義については指標用語集を参照してください。
メッセージイベントの種類（OneSignal）イベント名（データセット内）イベントの説明
Push Sentmessage.push.sentプッシュ通知がプッシュサービス（FCM、APNSなど）に正常に送信されました。
Push Receivedmessage.push.receivedプッシュ通知が受信者によって受信されました。すべてのプラットフォームで利用可能ではありません。詳細については、確認済み配信を参照してください。
Push Clickedmessage.push.clickedユーザーがプッシュ通知をタップしてデバイスでアプリを開きました。
Push Failedmessage.push.failedプッシュの送信に失敗しました。詳細については、プッシュメッセージレポートを参照してください。
Push Unsubscribedmessage.push.unsubscribedユーザーがプッシュサブスクリプションで配信停止しました。プッシュサブスクリプションステータスはいつ更新されますか？を参照してください。
In-App Impressionmessage.iam.impressionアプリ内メッセージがデバイスに正常に表示されました。
In-App Clickedmessage.iam.clickedユーザーがアプリ内メッセージの要素をタップしました。
In-App Page Displayedmessage.iam.page_displayedアプリ内メッセージページが表示されました。カルーセルの追跡に役立ちます。
Email Sentmessage.email.sentメールが正常に送信されました。
Email Receivedmessage.email.receivedメールが受信者によって受信されました。
Email Openedmessage.email.openedメールが受信者によって開封されました。詳細については、メールメッセージレポートを参照してください。
Email Link Clickedmessage.email.clickedユーザーがメール内のリンクをタップしました。
Email Unsubscribedmessage.email.unsubscribedユーザーが配信停止リンクを介してメールから配信停止しました。
Email Reported As Spammessage.email.reported_as_spamユーザーがメールをスパムとして報告しました。Gmailは追跡にGoogle Postmaster Toolsを必要とします。詳細については、メール配信性を参照してください。
Email Bouncedmessage.email.bounced永続的なエラーのためにメールが送信者に返されました。詳細については、メールメッセージレポートを参照してください。
Email Failedmessage.email.failedメールを配信できませんでした。詳細については、メールメッセージレポートを参照してください。
Email Suppressedmessage.email.suppressedメールアドレスが抑制リストにあるため、メールを送信できませんでした。
SMS Sentmessage.sms.sentSMSが受信者に送信されました。
SMS Failedmessage.sms.failedSMSの送信に失敗しました。詳細については、SMSメッセージレポートを参照してください。
SMS Deliveredmessage.sms.deliveredSMSが正常に配信されました。
SMS Undeliveredmessage.sms.undeliveredSMSを送信できませんでした。詳細については、SMSメッセージレポートを参照してください。
Live Activity Sentmessage.live_activity.sentLive ActivityがFCM/APNSに正常に送信されました。
Live Activity Deliveredmessage.live_activity.delivered受信者がLive Activityを受信しました。
Live Activity Unsubscribedmessage.live_activity.unsubscribedユーザーがLive Activitiesの購読を解除しました。
Live Activity Failedmessage.live_activity.failedLive Activityの送信に失敗しました。
Live Activity Clickedmessage.live_activity.clickedユーザーがLive Activityをクリックしました。

​
イベントオブジェクトの例

このLiquidテンプレートをイベントストリームボディにコピーして、すべてのイベントフィールドをキャプチャします：
JSON
{
  "event.kind": "{{ event.kind }}",
  "event.id": "{{ event.id }}",
  "event.timestamp": "{{ event.timestamp }}",
  "event.datetime": "{{ event.datetime }}",
  "event.app_id": "{{ event.app_id }}",
  "event.subscription_device_type": "{{ event.subscription_device_type }}",
  "event.subscription_id": "{{ event.subscription_id }}",
  "event.onesignal_id": "{{ event.onesignal_id }}",
  "event.external_id": "{{ event.external_id }}",
  "event.data.page_name": "{{ event.data.page_name }}",
  "event.data.page_id": "{{ event.data.page_id }}",
  "event.data.target_name": "{{ event.data.target_name }}",
  "event.data.target_id": "{{ event.data.target_id }}",
  "event.data.failure_reason": "{{ event.data.failure_reason }}"
}
プッシュクリックイベントのLiquidレンダリング後の例：
JSON
{
  "event.kind": "message.push.clicked",
  "event.id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "event.timestamp": 1708559115,
  "event.datetime": "2024-02-21T23:45:15.228Z",
  "event.app_id": "your-onesignal-app-id",
  "event.subscription_device_type": "iOS",
  "event.subscription_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "event.onesignal_id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "event.external_id": "user_12345",
  "event.data.page_name": "",
  "event.data.page_id": "",
  "event.data.target_name": "",
  "event.data.target_id": "",
  "event.data.failure_reason": ""
}
event.data.page_name などのチャネル固有フィールドは、それらを含まないイベントカインドでは空になります。

​
messageプロパティ

message オブジェクトは、エンドユーザーに送信されたメッセージ（ID、テンプレート、内容、URLを含む）を説明します。
​
message.id
UUID
OneSignalによって生成されたメッセージID。Liquid： {{ message.id }}
​
message.name
string
ダッシュボードまたはAPI name プロパティを使用して設定されたメッセージの名前。Liquid： {{ message.name }}
​
message.title
object
プッシュメッセージのタイトルまたはメールの件名。プッシュの場合、{'en':'Your title'} のようなローカライズされたオブジェクトを返します。メールの場合、件名を平文字列として返します。ダッシュボードまたはAPI headings / email_subject プロパティで設定します。Liquid： {{ message.title }}
​
message.contents
object
プッシュまたはSMSメッセージの内容（50文字でクリップ）。メールの内容（email_body）は提供されません。ダッシュボードまたはAPI contents プロパティで設定します。Liquid： {{ message.contents }}
​
message.template_id
UUID
JourneysまたはAPI template_id プロパティを介して送信されたメッセージのテンプレートID。Liquid： {{ message.template_id }}
​
message.url
string
WebとアプリにとらわれないURLを使用する場合のメッセージの起動URL。詳細についてはURL、リンク、ディープリンクを参照してください。Liquid： {{ message.url }}
​
message.app_url
string
WebとアプリのURLを別々に使用する場合のアプリ固有の起動URL。詳細についてはURL、リンク、ディープリンクを参照してください。Liquid： {{ message.app_url }}
​
message.web_url
string
WebとアプリのURLを別々に使用する場合のWeb固有の起動URL。詳細についてはURL、リンク、ディープリンクを参照してください。Liquid： {{ message.web_url }}
​
message.live_activity_event_kind
string
Live Activityのアクションタイプ：start、update、または end。message.live_activity.* イベントにのみ存在します。Liquid： {{ message.live_activity_event_kind }}

​
メッセージオブジェクトの例

このLiquidテンプレートをイベントストリームボディにコピーして、すべてのメッセージフィールドをキャプチャします：
JSON
{
  "message.id": "{{ message.id }}",
  "message.name": "{{ message.name }}",
  "message.title": "{{ message.title }}",
  "message.contents": "{{ message.contents }}",
  "message.template_id": "{{ message.template_id }}",
  "message.url": "{{ message.url }}",
  "message.app_url": "{{ message.app_url }}",
  "message.web_url": "{{ message.web_url }}"
}
プッシュ通知メッセージ：
JSON
{
  "message.id": "f3c9cd09-10d7-4f59-b9bc-66e16607f1d5",
  "message.name": "weekly-promo-push",
  "message.title": "{'en':'Flash Sale: 50% Off Today'}",
  "message.contents": "{'en':'Shop now and save on select items'}",
  "message.template_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "message.url": "https://example.com/sale",
  "message.app_url": "",
  "message.web_url": ""
}
メールメッセージ — message.title は件名の平文字列で、message.contents はメール本文のコンテンツがイベントストリームデータに含まれないため空になります：
JSON
{
  "message.id": "e2d3c4b5-a6f7-8901-bcde-f12345678901",
  "message.name": "onboarding-welcome-email",
  "message.title": "Welcome to Acme — here's how to get started",
  "message.contents": "",
  "message.template_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "message.url": "",
  "message.app_url": "",
  "message.web_url": ""
}

​
userプロパティ

user オブジェクトには、メッセージを受信したユーザーのプロファイルレベルのデータが含まれます。
​
user.onesignal_id
string
ユーザーのOneSignal ID。Liquid： {{ user.onesignal_id }}
​
user.external_id
string
ユーザーのExternal ID。Liquid： {{ user.external_id }}
​
user.tags
object
ユーザーのタグ。{{ user.tags }} でオブジェクト全体にアクセスするか、{{ user.tags.your_tag }} で特定のタグにアクセスします。タグが未設定の場合のデフォルト値：{{ user.tags.your_tag | default: '' }}。
​
user.language
string
ユーザーの言語コード。Liquid： {{ user.language }}

​
subscriptionプロパティ

これらのプロパティは、メッセージを受信したサブスクリプションを説明します。
​
user.subscription.id
string
サブスクリプションのOneSignal ID。Liquid： {{ user.subscription.id }}
​
user.subscription.app_id
string
OneSignal App ID。Liquid： {{ user.subscription.app_id }}
​
user.subscription.subscription_token
string
サブスクリプションのプラットフォーム固有トークン。メールの場合はメールアドレス。SMSの場合はE.164形式の電話番号。プッシュの場合はプッシュトークン。Liquid： {{ user.subscription.subscription_token }}
​
user.subscription.session_count
number
このサブスクリプションで記録された総セッション数。Liquid： {{ user.subscription.session_count }}
​
user.subscription.language
string
サブスクリプションに設定された言語コード。Liquid： {{ user.subscription.language }}
​
user.subscription.game_version
string
サブスクリプションが報告するアプリまたはゲームのバージョン。Liquid： {{ user.subscription.game_version }}
​
user.subscription.last_active
number
サブスクリプションの最後のセッションのUNIXタイムスタンプ。Liquid： {{ user.subscription.last_active }}
​
user.subscription.play_time
number
このサブスクリプションで記録された総プレイ時間（秒）。Liquid： {{ user.subscription.play_time }}
​
user.subscription.amount_spent
number
このサブスクリプションで記録されたアプリ内購入の総額。Liquid： {{ user.subscription.amount_spent }}
​
user.subscription.created_at
number
サブスクリプションが作成された時のUNIXタイムスタンプ。Liquid： {{ user.subscription.created_at }}
​
user.subscription.subscribed
boolean
サブスクリプションが現在オプトインされているかどうか。Liquid： {{ user.subscription.subscribed }}
​
user.subscription.sdk
string
サブスクリプションのデバイスのOneSignal SDKバージョン。Liquid： {{ user.subscription.sdk }}
​
user.subscription.device_model
string
デバイスのハードウェアモデル（例：“iPhone14,2”、“Pixel 7”）。Liquid： {{ user.subscription.device_model }}
​
user.subscription.device_os
string
デバイスのオペレーティングシステムとバージョン（例：“iOS 17.2”、“Android 14”）。Liquid： {{ user.subscription.device_os }}

​
関連ページ

Event Streams

Event Streamsのセットアップと設定（設定、ボディテンプレート、デバッグを含む）。

Liquid構文の使用

イベントストリームボディのパーソナライズに使用するLiquid構文のリファレンス。

アプリ内メッセージイベントストリーム

アプリ内メッセージイベントデータとカルーセル追跡の詳細。

指標用語集

チャネル全体のすべてのメッセージイベント指標の定義。

​
よくある質問

​
一部のイベントデータが欠損または空白になるのはなぜですか？

JourneysおよびAPIによるメッセージデータは30日間保持されます。ユーザーがメッセージ送信後30日以上経過してからインタラクション（クリック、開封、配信停止）を行った場合、関連するメッセージプロパティが空白になることがあります。これを回避するには、インタラクションイベントの message.id を元の sent イベント（完全なメッセージデータを含む）と照合してください。

​
event.id と message.id の違いは何ですか？

event.id は個別のイベントの一意の識別子です（例：特定の1回のクリック）。message.id は送信されたメッセージの識別子です — 複数のイベントが同じ message.id を共有できます（例：同じプッシュ通知の sent イベントと clicked イベント）。

​
プッシュとメールで message.title の形式はどうなりますか？

プッシュ通知の場合、message.title は {'en':'Your title'} のようなローカライズされたオブジェクトを返します。メールの場合、件名を平文字列として返します。形式はチャネルによって異なります。

​
カスタムイベントはEvent Streamsに含まれますか？

いいえ。Event Streamsにはメッセージイベント（送信済み、クリック、開封、バウンスなど）が含まれ、カスタムイベントは含まれません。カスタムイベントはOneSignalに送信するユーザーアクションです。Event Streamsはメッセージ配信とエンゲージメントデータをOneSignalから_エクスポート_します。

​
イベントストリームボディで特定のタグを参照するにはどうすればよいですか？

正確なタグキーで {{ user.tags.your_tag_key }} を使用します。タグが設定されていない場合のエラーを回避するには、デフォルト値を追加します：{{ user.tags.your_tag_key | default: '' }}。詳細についてはLiquid構文の使用を参照してください。