メインコンテンツへスキップ
Liquid構文を使用してイベントストリームデータにアクセスします。目的のデータポイントを{{ }}でラップして、イベントストリームでそのデータをキャプチャします。例を参照してください。

​
eventプロパティ

eventオブジェクトには次のプロパティが含まれます：

​
Kind

型: String メッセージタイプ（push、email、sms、iam）とイベント（例：received、sent、clicked、failed、unsubscribed、displayed、pagedisplayed、opened、clicked、unsubscribed、reported_as_spam、hardbounced、failed、supressed）。 使用法: {{ event.kind }}
メッセージイベントの種類（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.displayedアプリ内メッセージがデバイスに正常に表示されました。
In-App Clickedmessage.iam.clickedユーザーがアプリ内メッセージの要素をタップしました。
In-App Page Displayedmessage.iam.pagedisplayedアプリ内メッセージページが表示されました。カルーセルの追跡に役立ちます。
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.hardbounced永続的なエラーのためにメールが送信者に返されました。詳細については、メールメッセージレポートを参照してください。
Email Failedmessage.email.failedメールを配信できませんでした。詳細については、メールメッセージレポートを参照してください。
Email Suppressedmessage.email.supressedメールアドレスが抑制リストにあるため、メールを送信できませんでした。
SMS Sentmessage.sms.sentSMSが受信者に送信されました
SMS Failedmessage.sms.failedSMSの送信に失敗しました。詳細については、SMSメッセージレポートを参照してください。
SMS Deliveredmessage.sms.deliveredSMSが正常に配信されました
SMS Undeliveredmessage.sms.undeliveredSMSを送信できませんでした。詳細については、SMSメッセージレポートを参照してください。

​
Event ID

型: UUID UUID v4形式の各個別イベントに対する一意のOneSignal生成識別子。このIDを冪等配信追跡に使用します。特定のメッセージまたはテンプレート識別子を探している場合は、message.idまたはmessage.template_idを使用してください。 使用法: {{ event.id }}

​
Timestamp

型: Integer イベントのUNIXタイムスタンプ。 使用法: {{ event.timestamp }}

​
UTC datetime

型: String UTC形式のイベントの人間が読める時刻（具体的には「2024-02-21T23:45:15.228Z」のようなISO文字列）。 使用法: {{ event.datetime }}

​
App ID

型: UUID OneSignal App ID。 使用法: {{ event.app_id }}

​
Subscription type

型: String サブスクリプションタイプ（例：iOS、Android、Chrome、Email、SMSなど）。 使用法: {{ event.subscription_device_type }}

​
Subscription ID

型: UUID OneSignal Subscription ID。 使用法: {{ event.subscription_id }}

​
OneSignal User ID

型: UUID OneSignalが作成したUser ID。 使用法: {{ event.onesignal_id }}

​
External User ID

型: String OneSignal External IDエイリアスとして設定されたユーザーID。OneSignalで設定されていない場合は空になることがあります。 使用法: {{ event.external_id }}

​
In-app message page name

型: String 特定のアプリ内メッセージイベントに対して表示されるページまたはカードの名前。詳細については、アプリ内メッセージイベントストリームを参照してください。 使用法: {{ event.data.page_name }}

​
In-app message page ID

型: String 特定のアプリ内メッセージイベントに対して表示されるページまたはカードの一意の識別子。詳細については、アプリ内メッセージイベントストリームを参照してください。 使用法: {{ event.data.page_id }}

​
In-app message target name

型: String クリックされたボタンまたは画像ブロック要素の名前。アプリ内クリックアクションを含む必要があります。詳細については、アプリ内メッセージイベントストリームを参照してください。 使用法: {{ event.data.target_name }}

​
In-app message target ID

型: String クリックされたボタンまたは画像ブロック要素の一意の識別子。アプリ内クリックアクションを含む必要があります。詳細については、アプリ内メッセージイベントストリームを参照してください。 使用法: {{ event.data.target_id }}

​
Example Input

{
  "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}}"
}

​
メッセージプロパティ

messageオブジェクトは、エンドユーザーに送信されたメッセージについて通知するように設計されています。メッセージの実際のテキストを含むid、template_id、contentなどのプロパティが含まれます。

​
Message ID

型: UUID OneSignalによって生成されたメッセージID。 使用法: {{ message.id }}

​
Message Name

型: String ダッシュボードまたはAPI nameプロパティを使用して設定されたメッセージの名前。 使用法: {{ message.name }}

​
Message Title

型: Object ダッシュボードまたはAPI headingsまたはemail_subjectプロパティを使用して設定されたプッシュメッセージのタイトルまたはメールの件名。 使用法: {{ message.title }}

​
Message Contents

型: Object ダッシュボードまたはAPI contentsプロパティを使用して設定されたプッシュまたはSMSメッセージの内容（50文字でクリップされます）。メールの内容（email_body）は提供されません。 使用法: {{ message.contents }}

​
Template ID

型: UUID Journeysまたは API template_idプロパティを介して送信されたメッセージのテンプレートID。 使用法: {{ message.template_id }}

​
Launch URL

型: String メッセージの起動URL（Webとアプリにとらわれない単一のURLのみを使用する場合）。詳細については、URL、リンク、ディープリンクを参照してください。 使用法: {{ message.url }}

​
App-Specific URL

型: String WebとアプリFixed URLの両方を使用する場合のメッセージの起動URL。詳細については、URL、リンク、ディープリンクを参照してください。 使用法: {{ message.app_url }}

​
Web-Specific URL

型: String WebとアプリFixed URLの両方を使用する場合のメッセージの起動URL。詳細については、URL、リンク、ディープリンクを参照してください。 使用法: {{ message.web_url }}

​
Example Message Object

{
  "message.id": "f3c9cd09-10d7-4f59-b9bc-66e16607f1d5",
  "message.name": "the-name-you-set",
  "message.title": "Claim 50% Off Today", // email subject example
  "message.title": "{'en':'the message title/headings'}", // push title example
  "message.contents": "{'en':'the message content'}",
  "message.template_id": "the-template-uuid-if-set",
  "message.url": "the-message-url",
  "message.app_url": "the-message-app-url",
  "message.web_url": "the-message-web-url"
}

​
ユーザープロパティ

​
OneSignal ID

型: String ユーザーのOneSignal ID。 使用法 {{ user.onesignal_id }}

​
External ID

型: String ユーザーのExternal ID。 使用法: {{ user.external_id }}

​
Tags

型: Object ユーザーのタグ。 使用法:
  • タグオブジェクト: {{ user.tags }}
  • 特定のタグ文字列: {{ user.tags.your_tag }}
  • すべてのタグを取得しようとしている場合は、{{ user.tags}}のようにタグオブジェクトを参照してください。
  • 特定のタグを取得しようとしている場合は、"{{ user.tags.your_tag | default: '' }}"のようにタグを文字列として参照してください。

​
Language

型: String ユーザーの言語。 使用法: {{ user.language }}

​
サブスクリプションプロパティ

​
Subscription ID

型: String メッセージが送信されたサブスクリプションのID。 使用法: {{ user.subscription.id }}

​
App ID

型: String アプリのID。 使用法: {{ user.subscription.app_id }}

​
Subscription Token

型: String メッセージが送信されたサブスクリプションのトークン。
  • タイプがEmailの場合、トークンはメールアドレスになります。
  • タイプがSMSの場合、トークンはE.164形式の電話番号になります。
  • タイプがPushオプションのいずれかである場合、トークンはプッシュトークンになります。
使用法: {{ user.subscription.subscription_token }}

​
Session Count

型: Number メッセージが送信されたサブスクリプションのセッション数。 使用法: {{ user.subscription.session_count }}

​
Language

型: String メッセージが送信されたサブスクリプションに設定された言語。 使用法: {{ user.subscription.language }}

​
Game Version

型: String メッセージが送信されたサブスクリプションに設定されたゲームバージョン。 使用法: {{ user.subscription.game_version }}

​
Last Active

型: Number メッセージが送信されたサブスクリプションに設定された最終アクティブ時刻。 使用法: {{ user.subscription.last_active }}

​
Play Time

型: Number メッセージが送信されたサブスクリプションに設定されたプレイ時間。 使用法: {{ user.subscription.play_time }}

​
Amount Spent

型: Number メッセージが送信されたサブスクリプションで使用された金額。 使用法: {{ user.subscription.amount_spent }}

​
Created At

型: Number メッセージが送信されたサブスクリプションの作成時刻。 使用法: {{ user.subscription.created_at }}

​
Subscribed

型: Boolean メッセージが送信されたサブスクリプションが現在サブスクライブされているかどうかを示します。 使用法: {{ user.subscription.subscribed }}

​
SDK

型: String メッセージが送信されたサブスクリプションに設定されたSDKバージョン。 使用法: {{ user.subscription.sdk }}

​
Device Model

型: String メッセージが送信されたサブスクリプションに設定されたデバイスモデル。 使用法: {{ user.subscription.device_model }}

​
Device OS

型: String メッセージが送信されたサブスクリプションに設定されたデバイスオペレーティングシステム。 使用法: {{ user.subscription.device_os }}

​
Tags

型: Object ユーザーのタグ。オブジェクト全体または特定のタグにアクセスできます。 使用法:
  • すべてのタグ: {{ user.tags }}
  • 特定のタグ: {{ user.tags.your_tag }}