> ## Documentation Index
> Fetch the complete documentation index at: https://documentation.onesignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# イベントストリームデータリファレンス

> イベントストリームとWebhooksで利用可能なすべてのevent、message、user、subscriptionプロパティのスキーマリファレンス。各フィールドのLiquid構文も含まれます。

[Liquid構文を使用して](./using-liquid-syntax)イベントストリームデータにアクセスします。任意のフィールドを `{{ }}` でラップしてイベントストリームボディに含めます。[例](./event-streams#example-body)を参照してください。

<Warning>
  JourneysおよびAPIによるメッセージデータは30日間保持されます。30日後に発生したインタラクションイベント（クリック、開封、配信停止）はメッセージプロパティが空白になる場合があります。データを復元するには、インタラクションイベントの `message.id` を元の `sent` イベント（完全なメッセージデータを含む）と照合してください。
</Warning>

## `event`プロパティ

すべてのイベントには以下のコアフィールドが含まれます。`event.data.*` のチャネル固有フィールドは適用可能な場合のみ含まれます — [チャネル固有フィールド](#channel-specific-fields)を参照してください。

<ParamField body="event.kind" type="string">
  チャネルとアクションを組み合わせたイベントタイプ（例：`message.push.clicked`、`message.email.bounced`）。値の完全なリストは以下の[イベントカインドリファレンス](#event-kind-reference)を参照してください。**Liquid：** `{{ event.kind }}`
</ParamField>

<ParamField body="event.id" type="UUID">
  UUID v4形式の各個別イベントに対するOneSignal生成の一意の識別子。このIDを冪等配信追跡に使用します。メッセージまたはテンプレート識別子には、[`message.id`](#message-id) または [`message.template_id`](#template-id) を使用してください。**Liquid：** `{{ event.id }}`
</ParamField>

<ParamField body="event.timestamp" type="integer">
  イベントのUNIXタイムスタンプ。**Liquid：** `{{ event.timestamp }}`
</ParamField>

<ParamField body="event.datetime" type="string">
  ISO 8601文字列としてUTCで表示したイベントの人間が読める時刻（例："2024-02-21T23:45:15.228Z"）。**Liquid：** `{{ event.datetime }}`
</ParamField>

<ParamField body="event.app_id" type="UUID">
  OneSignal [App ID](./keys-and-ids)。**Liquid：** `{{ event.app_id }}`
</ParamField>

<ParamField body="event.subscription_device_type" type="string">
  サブスクリプションタイプ（例：`iOS`、`Android`、`Chrome`、`Email`、`SMS`）。**Liquid：** `{{ event.subscription_device_type }}`
</ParamField>

<ParamField body="event.subscription_id" type="UUID">
  OneSignal [Subscription ID](./subscriptions)。**Liquid：** `{{ event.subscription_id }}`
</ParamField>

<ParamField body="event.onesignal_id" type="UUID">
  OneSignal [User ID](./users)。**Liquid：** `{{ event.onesignal_id }}`
</ParamField>

<ParamField body="event.external_id" type="string">
  OneSignal [External ID](./users) エイリアスとして設定されたユーザーID。設定されていない場合は空になることがあります。**Liquid：** `{{ event.external_id }}`
</ParamField>

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

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

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

`message.iam.*` イベントに含まれます。詳細については[アプリ内メッセージイベントストリーム](./iam-event-streams)を参照してください。

<ParamField body="event.data.page_name" type="string">
  表示されたアプリ内メッセージページまたはカードの名称。**Liquid：** `{{ event.data.page_name }}`
</ParamField>

<ParamField body="event.data.page_id" type="string">
  表示されたアプリ内メッセージページまたはカードの一意の識別子。**Liquid：** `{{ event.data.page_id }}`
</ParamField>

<ParamField body="event.data.target_name" type="string">
  クリックされたボタンまたは画像ブロック要素の名称。要素には[アプリ内クリックアクション](./iam-click-actions)が含まれている必要があります。**Liquid：** `{{ event.data.target_name }}`
</ParamField>

<ParamField body="event.data.target_id" type="string">
  クリックされたボタンまたは画像ブロック要素の一意の識別子。**Liquid：** `{{ event.data.target_id }}`
</ParamField>

#### Live Activityイベント

`message.live_activity.*` イベントに含まれます。

<ParamField body="event.data.live_activity_id" type="string">
  特定のLive Activityの一意の識別子（例："Knicks vs Cavs - Oct 22 7PM"）。**Liquid：** `{{ event.data.live_activity_id }}`
</ParamField>

<ParamField body="event.data.live_activity_type" type="string">
  Live Activityカテゴリのグループ化ラベル（例："Knicks\_games"）。**Liquid：** `{{ event.data.live_activity_type }}`
</ParamField>

#### 失敗イベント

`message.push.failed` と `message.email.failed` イベントに含まれます。

<ParamField body="event.data.failure_reason" type="string">
  メッセージの送信が失敗した理由。一般的な理由については[プッシュメッセージレポート](./push-notification-message-reports#failure-message-troubleshooting)または[メールメッセージレポート](./email-message-reports#why-are-my-emails-marked-as-failed)を参照してください。**Liquid：** `{{ event.data.failure_reason }}`
</ParamField>

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

各指標の詳細な定義については[指標用語集](./analytics-metrics-glossary)を参照してください。

| メッセージイベントの種類（OneSignal）    | イベント名（データセット内）                       | イベントの説明                                                                                                                                                |
| -------------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Push Sent                  | `message.push.sent`                  | プッシュ通知がプッシュサービス（FCM、APNSなど）に正常に送信されました。                                                                                                                |
| Push Received              | `message.push.received`              | プッシュ通知が受信者によって受信されました。すべてのプラットフォームで利用可能ではありません。詳細については、[確認済み配信](./confirmed-delivery)を参照してください。                                                        |
| Push Clicked               | `message.push.clicked`               | ユーザーがプッシュ通知をタップしてデバイスでアプリを開きました。                                                                                                                       |
| Push Failed                | `message.push.failed`                | プッシュの送信に失敗しました。詳細については、[プッシュメッセージレポート](./push-notification-message-reports)を参照してください。                                                                  |
| Push Unsubscribed          | `message.push.unsubscribed`          | ユーザーがプッシュ[サブスクリプション](./subscriptions)で配信停止しました。[プッシュサブスクリプションステータスはいつ更新されますか？](./subscriptions#when-do-push-subscription-statuses-update%3F)を参照してください。 |
| In-App Impression          | `message.iam.impression`             | アプリ内メッセージがデバイスに正常に表示されました。                                                                                                                             |
| In-App Clicked             | `message.iam.clicked`                | ユーザーがアプリ内メッセージの要素をタップしました。                                                                                                                             |
| In-App Page Displayed      | `message.iam.page_displayed`         | アプリ内メッセージページが表示されました。カルーセルの追跡に役立ちます。                                                                                                                   |
| Email Sent                 | `message.email.sent`                 | メールが正常に送信されました。                                                                                                                                        |
| Email Received             | `message.email.received`             | メールが受信者によって受信されました。                                                                                                                                    |
| Email Opened               | `message.email.opened`               | メールが受信者によって開封されました。詳細については、[メールメッセージレポート](./email-message-reports)を参照してください。                                                                           |
| Email Link Clicked         | `message.email.clicked`              | ユーザーがメール内のリンクをタップしました。                                                                                                                                 |
| Email Unsubscribed         | `message.email.unsubscribed`         | ユーザーが[配信停止リンク](./unsubscribe-links-email-subscriptions)を介してメールから配信停止しました。                                                                              |
| Email Reported As Spam     | `message.email.reported_as_spam`     | ユーザーがメールをスパムとして報告しました。Gmailは追跡に[Google Postmaster Tools](./google-postmaster-tools)を必要とします。詳細については、[メール配信性](./email-deliverability)を参照してください。          |
| Email Bounced              | `message.email.bounced`              | 永続的なエラーのためにメールが送信者に返されました。詳細については、[メールメッセージレポート](./email-message-reports)を参照してください。                                                                    |
| Email Failed               | `message.email.failed`               | メールを配信できませんでした。詳細については、[メールメッセージレポート](./email-message-reports)を参照してください。                                                                               |
| Email Suppressed           | `message.email.suppressed`           | メールアドレスが[抑制リスト](./email-deliverability)にあるため、メールを送信できませんでした。                                                                                           |
| SMS Sent                   | `message.sms.sent`                   | SMSが受信者に送信されました。                                                                                                                                       |
| SMS Failed                 | `message.sms.failed`                 | SMSの送信に失敗しました。詳細については、[SMSメッセージレポート](./sms-message-reports)を参照してください。                                                                                  |
| SMS Delivered              | `message.sms.delivered`              | SMSが正常に配信されました。                                                                                                                                        |
| SMS Undelivered            | `message.sms.undelivered`            | SMSを送信できませんでした。詳細については、[SMSメッセージレポート](./sms-message-reports)を参照してください。                                                                                 |
| Live Activity Sent         | `message.live_activity.sent`         | Live ActivityがFCM/APNSに正常に送信されました。                                                                                                                     |
| Live Activity Delivered    | `message.live_activity.delivered`    | 受信者がLive Activityを受信しました。                                                                                                                              |
| Live Activity Unsubscribed | `message.live_activity.unsubscribed` | ユーザーがLive Activitiesの購読を解除しました。                                                                                                                        |
| Live Activity Failed       | `message.live_activity.failed`       | Live Activityの送信に失敗しました。                                                                                                                               |
| Live Activity Clicked      | `message.live_activity.clicked`      | ユーザーがLive Activityをクリックしました。                                                                                                                           |

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

このLiquidテンプレートをイベントストリームボディにコピーして、すべてのイベントフィールドをキャプチャします：

```json JSON theme={null}
{
  "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 }}"
}
```

<Accordion title="レンダリング出力例">
  プッシュクリックイベントのLiquidレンダリング後の例：

  ```json JSON theme={null}
  {
    "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` などのチャネル固有フィールドは、それらを含まないイベントカインドでは空になります。
</Accordion>

***

## `message`プロパティ

`message` オブジェクトは、エンドユーザーに送信されたメッセージ（ID、テンプレート、内容、URLを含む）を説明します。

<ParamField body="message.id" type="UUID">
  OneSignalによって生成されたメッセージID。**Liquid：** `{{ message.id }}`
</ParamField>

<ParamField body="message.name" type="string">
  ダッシュボードまたはAPI `name` プロパティを使用して設定されたメッセージの名前。**Liquid：** `{{ message.name }}`
</ParamField>

<ParamField body="message.title" type="object">
  プッシュメッセージのタイトルまたはメールの件名。プッシュの場合、`{'en':'Your title'}` のようなローカライズされたオブジェクトを返します。メールの場合、件名を平文字列として返します。ダッシュボードまたはAPI `headings` / `email_subject` プロパティで設定します。**Liquid：** `{{ message.title }}`
</ParamField>

<ParamField body="message.contents" type="object">
  プッシュまたはSMSメッセージの内容（50文字でクリップ）。メールの内容（`email_body`）は提供されません。ダッシュボードまたはAPI `contents` プロパティで設定します。**Liquid：** `{{ message.contents }}`
</ParamField>

<ParamField body="message.template_id" type="UUID">
  JourneysまたはAPI `template_id` プロパティを介して送信されたメッセージのテンプレートID。**Liquid：** `{{ message.template_id }}`
</ParamField>

<ParamField body="message.url" type="string">
  WebとアプリにとらわれないURLを使用する場合のメッセージの起動URL。詳細については[URL、リンク、ディープリンク](./links)を参照してください。**Liquid：** `{{ message.url }}`
</ParamField>

<ParamField body="message.app_url" type="string">
  WebとアプリのURLを別々に使用する場合のアプリ固有の起動URL。詳細については[URL、リンク、ディープリンク](./links)を参照してください。**Liquid：** `{{ message.app_url }}`
</ParamField>

<ParamField body="message.web_url" type="string">
  WebとアプリのURLを別々に使用する場合のWeb固有の起動URL。詳細については[URL、リンク、ディープリンク](./links)を参照してください。**Liquid：** `{{ message.web_url }}`
</ParamField>

<ParamField body="message.live_activity_event_kind" type="string">
  Live Activityのアクションタイプ：`start`、`update`、または `end`。`message.live_activity.*` イベントにのみ存在します。**Liquid：** `{{ message.live_activity_event_kind }}`
</ParamField>

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

このLiquidテンプレートをイベントストリームボディにコピーして、すべてのメッセージフィールドをキャプチャします：

```json JSON theme={null}
{
  "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 }}"
}
```

<Accordion title="レンダリング出力例">
  プッシュ通知メッセージ：

  ```json JSON theme={null}
  {
    "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 JSON theme={null}
  {
    "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": ""
  }
  ```
</Accordion>

***

## `user`プロパティ

`user` オブジェクトには、メッセージを受信したユーザーのプロファイルレベルのデータが含まれます。

<ParamField body="user.onesignal_id" type="string">
  ユーザーのOneSignal ID。**Liquid：** `{{ user.onesignal_id }}`
</ParamField>

<ParamField body="user.external_id" type="string">
  ユーザーのExternal ID。**Liquid：** `{{ user.external_id }}`
</ParamField>

<ParamField body="user.tags" type="object">
  ユーザーの[タグ](./add-user-data-tags)。`{{ user.tags }}` でオブジェクト全体にアクセスするか、`{{ user.tags.your_tag }}` で特定のタグにアクセスします。タグが未設定の場合のデフォルト値：`{{ user.tags.your_tag | default: '' }}`。
</ParamField>

<ParamField body="user.language" type="string">
  ユーザーの言語コード。**Liquid：** `{{ user.language }}`
</ParamField>

***

## `subscription`プロパティ

これらのプロパティは、メッセージを受信した[サブスクリプション](./subscriptions)を説明します。

<ParamField body="user.subscription.id" type="string">
  サブスクリプションのOneSignal ID。**Liquid：** `{{ user.subscription.id }}`
</ParamField>

<ParamField body="user.subscription.app_id" type="string">
  OneSignal App ID。**Liquid：** `{{ user.subscription.app_id }}`
</ParamField>

<ParamField body="user.subscription.subscription_token" type="string">
  サブスクリプションのプラットフォーム固有トークン。**メール**の場合はメールアドレス。**SMS**の場合はE.164形式の電話番号。**プッシュ**の場合はプッシュトークン。**Liquid：** `{{ user.subscription.subscription_token }}`
</ParamField>

<ParamField body="user.subscription.session_count" type="number">
  このサブスクリプションで記録された総セッション数。**Liquid：** `{{ user.subscription.session_count }}`
</ParamField>

<ParamField body="user.subscription.language" type="string">
  サブスクリプションに設定された言語コード。**Liquid：** `{{ user.subscription.language }}`
</ParamField>

<ParamField body="user.subscription.game_version" type="string">
  サブスクリプションが報告するアプリまたはゲームのバージョン。**Liquid：** `{{ user.subscription.game_version }}`
</ParamField>

<ParamField body="user.subscription.last_active" type="number">
  サブスクリプションの最後のセッションのUNIXタイムスタンプ。**Liquid：** `{{ user.subscription.last_active }}`
</ParamField>

<ParamField body="user.subscription.play_time" type="number">
  このサブスクリプションで記録された総プレイ時間（秒）。**Liquid：** `{{ user.subscription.play_time }}`
</ParamField>

<ParamField body="user.subscription.amount_spent" type="number">
  このサブスクリプションで記録されたアプリ内購入の総額。**Liquid：** `{{ user.subscription.amount_spent }}`
</ParamField>

<ParamField body="user.subscription.created_at" type="number">
  サブスクリプションが作成された時のUNIXタイムスタンプ。**Liquid：** `{{ user.subscription.created_at }}`
</ParamField>

<ParamField body="user.subscription.subscribed" type="boolean">
  サブスクリプションが現在オプトインされているかどうか。**Liquid：** `{{ user.subscription.subscribed }}`
</ParamField>

<ParamField body="user.subscription.sdk" type="string">
  サブスクリプションのデバイスのOneSignal SDKバージョン。**Liquid：** `{{ user.subscription.sdk }}`
</ParamField>

<ParamField body="user.subscription.device_model" type="string">
  デバイスのハードウェアモデル（例："iPhone14,2"、"Pixel 7"）。**Liquid：** `{{ user.subscription.device_model }}`
</ParamField>

<ParamField body="user.subscription.device_os" type="string">
  デバイスのオペレーティングシステムとバージョン（例："iOS 17.2"、"Android 14"）。**Liquid：** `{{ user.subscription.device_os }}`
</ParamField>

***

## 関連ページ

<Columns cols={2}>
  <Card title="Event Streams" icon="bolt" href="./event-streams">
    Event Streamsのセットアップと設定（設定、ボディテンプレート、デバッグを含む）。
  </Card>

  <Card title="Liquid構文の使用" icon="code" href="./using-liquid-syntax">
    イベントストリームボディのパーソナライズに使用するLiquid構文のリファレンス。
  </Card>

  <Card title="アプリ内メッセージイベントストリーム" icon="message" href="./iam-event-streams">
    アプリ内メッセージイベントデータとカルーセル追跡の詳細。
  </Card>

  <Card title="指標用語集" icon="chart-bar" href="./analytics-metrics-glossary">
    チャネル全体のすべてのメッセージイベント指標の定義。
  </Card>
</Columns>

***

## よくある質問

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

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には**メッセージイベント**（送信済み、クリック、開封、バウンスなど）が含まれ、[カスタムイベント](./custom-events)は含まれません。カスタムイベントはOneSignalに送信するユーザーアクションです。Event Streamsはメッセージ配信とエンゲージメントデータをOneSignalから\_エクスポート\_します。

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

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

***