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

eventプロパティ

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

チャネル固有フィールド

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

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

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

Live Activityイベント

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

失敗イベント

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

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

各指標の詳細な定義については指標用語集を参照してください。

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

このLiquidテンプレートをイベントストリームボディにコピーして、すべてのイベントフィールドをキャプチャします:
JSON
プッシュクリックイベントのLiquidレンダリング後の例:
JSON
event.data.page_name などのチャネル固有フィールドは、それらを含まないイベントカインドでは空になります。

messageプロパティ

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

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

このLiquidテンプレートをイベントストリームボディにコピーして、すべてのメッセージフィールドをキャプチャします:
JSON
プッシュ通知メッセージ:
JSON
メールメッセージ — message.title は件名の平文字列で、message.contents はメール本文のコンテンツがイベントストリームデータに含まれないため空になります:
JSON

userプロパティ

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

subscriptionプロパティ

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