> ## 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.

# サンプルアプリ：Event Streamsを使った通知受信箱

> サンプルアプリClean BeansがEvent Streamsからアプリ内の通知受信箱を構築し、配信停止に合わせてメールの設定を同期する方法。

このページは、1つの実在アプリを最初から最後まで追う[サンプルアプリ：OneSignalの完全な統合](https://documentation.onesignal.com/docs/ja/example-full-integration-overview.md)の一部です。アプリは**Clean Beans**という共同生活の家のための掃除当番表アプリで、Expo（React Native）とSupabaseバックエンドで構築されています。

スワイプで消したプッシュは失われます。Clean Beansはアプリ内に7日間の履歴を残し、すべての画面のヘッダーに未読数を表示します。

![Clean Beansの通知受信箱](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/cleanbeans-inbox.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=b5e476387dfc0b32a56d71201879c0d0)

受信箱には最近の通知が一覧表示されます。

アプリ自身は通知を記録しません。それでは、アプリが閉じている間に届いた通知を取りこぼしてしまいます。OneSignalは**Event Stream**を通じてすべてのプッシュをバックエンドに知らせ、バックエンドが履歴を保持します。

**1. OneSignalがプッシュごとにイベントを送信する**

Event Streamは、プッシュが送信されたときと、クリックされたときに、バックエンド関数にPOSTします。

**2. 関数が行を保存または更新する**

送信イベントで受信箱のエントリが作成されます。クリックイベントでそのエントリが既読になります。

**3. アプリがテーブルを読み取る**

受信箱の画面とヘッダーのバッジは、ユーザー自身の行を取得します。

## Event Streamを設定する \\

**ダッシュボードの設定。** **Data > Event Streams**で、次の内容のストリームを作成します。

* **URL：** 関数のアドレス。
* **ヘッダー：** 共有シークレット。たとえば`X-Webhook-Secret`。
* **イベント：** `message.push.sent`と`message.push.clicked`。
* **本文：** リクエストの形を決めるLiquidテンプレート。

```json Event Stream body theme={null}
{
  "event_kind": "{{ event.kind }}",
  "event_id": "{{ event.id }}",
  "timestamp": {{ event.timestamp }},
  "external_id": "{{ event.external_id }}",
  "message_id": "{{ message.id }}",
  "title": "{{ message.title.en }}",
  "contents": "{{ message.contents.en }}",
  "data": { "type": "{{ message.data.type }}" }
}
```

> [!WARNING]
>
> 上記のように、`data`の各キーは名前で参照してください。`{{ message.data }}`だけを使うと、オブジェクト全体がPython風のdict（`{'type': 'kudos'}`）として出力されます。これは有効なJSONではないため、下の関数は本文の解析時にリクエストを拒否します。タイトルとコンテンツを`.en`で読み取るのも同じ理由です。受信箱に必要なのは`type`だけです。独自のWebhookで使うほかのキーは、1行ずつ追加してください。
>
> 二重引用符を含む値もJSONを壊します。Kudosのプッシュにはユーザーが入力したテキストが含まれるため、`"`を含むkudosメッセージでは関数が解析できない本文が生成され、そのプッシュは受信箱に届きません。

> [!NOTE]
>
> このストリームは、すべてのデバイスに配信されたすべてのプッシュについてイベントを1件送信し、各イベントはプランのメッセージイベント量にカウントされます。使用するイベントだけを選択してください。

## イベントを受信する \\

関数は、ほかの処理より先にシークレットを確認します。

```typescript supabase/functions/inbox-webhook/index.ts theme={null}
const secret = req.headers.get('X-Webhook-Secret') ?? '';
if (!INBOX_WEBHOOK_SECRET || secret !== INBOX_WEBHOOK_SECRET) {
  return new Response('Unauthorized', { status: 401 });
}
```

送信イベントは受信箱の行になります。OneSignalのイベントIDが一意キーなので、同じイベントが2回届いても行は2つ作成されません。

```typescript supabase/functions/inbox-webhook/index.ts theme={null}
if (event_kind === 'message.push.sent') {
  // ── Create inbox entry ──
  const notifType = (data?.type as string) || 'general';

  // inboxTitle and inboxBody are the title and contents with any Liquid
  // rendered. See "Render Liquid before you store it" below.

  const { error } = await supabase.from('inbox_messages').upsert(
    {
      user_id: profile.id,
      onesignal_event_id: event_id,
      onesignal_message_id: message_id,
      title: inboxTitle || 'Notification',
      body: inboxBody,
      type: notifType,
      data: data || {},
      read: false,
      created_at: payload.timestamp
        ? new Date(payload.timestamp * 1000).toISOString()
        : new Date().toISOString(),
    },
    { onConflict: 'onesignal_event_id' } // dedup
  );
```

クリックイベントは、対応する行を既読にします。

```typescript supabase/functions/inbox-webhook/index.ts theme={null}
const { error, count } = await supabase
  .from('inbox_messages')
  .update({ read: true })
  .eq('onesignal_message_id', message_id)
  .eq('user_id', profile.id);
```

タップされたプッシュを振り分ける`data.type`フィールドも各行に保存されるため、受信箱は正しいアイコンを表示し、正しい画面を開けます。

## 保存する前にLiquidを展開する \\

ストリームは、OneSignalが受信者ごとにパーソナライズする前の、書かれたままのメッセージを報告します。バックエンドから送信したプッシュはすでに最終的なテキストになっていますが、Journeyのプッシュはそうではありません。Clean BeansのJourneyメッセージの1つには、次のタイトルがあります。

```text Journey push title theme={null}
{{ journey.first_event.properties.room_name }} cleaned ✅
```

端末には「Kitchen cleaned ✅」と表示されます。Webhookは上の行を受け取り、受信箱の最初のバージョンはそれをそのまま表示していました。

現在の関数は、値の参照と`default`フィルターに対応した小さなレンダラーで、保存前にタイトルと本文を自ら展開します。値は2か所から取得します。

* **タグ**はデータベースから読み取ります。アプリは保存している値から各タグを設定しているため、関数は同じ値を読み取れます。ストリームの本文で`{{ user.tags.user_name }}`を渡す方法でも動作しますが、名前に二重引用符が含まれると本文が無効なJSONになります。
* **Journeyのイベントプロパティ**はストリームでは利用できません。関数は、カスタムイベントを発生させた掃除セッションからこれらを再構築します。

```typescript supabase/functions/inbox-webhook/index.ts theme={null}
if (hasLiquid(inboxTitle) || hasLiquid(inboxBody)) {
  const context = await buildLiquidContext(supabase, payload);
  const renderedTitle = renderLiquid(inboxTitle, context);
  const renderedBody = renderLiquid(inboxBody, context);
  const unresolved = [...renderedTitle.unresolved, ...renderedBody.unresolved];

  if (unresolved.length > 0) {
    // Better no entry than one showing raw template tags
    console.warn(`Inbox: skipped ${message_id} for ${external_id}, unresolved Liquid: ${JSON.stringify(unresolved)}`);
    return jsonResponse({ skipped: true, reason: 'unresolved_liquid', unresolved });
  }

  inboxTitle = renderedTitle.text;
  inboxBody = renderedBody.text;
}
```

> [!WARNING]
>
> Event Streamsから受信箱やログを構築する場合は、Journeyとテンプレートのメッセージがどのような形で届くかを確認してください。含まれるLiquidは、Liquidのままです。ここでのように自分で展開するか、それらのメッセージを除外してください。

## 受信箱を表示する \\

行レベルセキュリティにより各ユーザーは自分の行しか読み取れないため、アプリのクエリでユーザーによる絞り込みは不要です。

```typescript app/inbox.tsx theme={null}
const { data, error } = await supabase
  .from('inbox_messages')
  .select('id, title, body, type, data, read, created_at')
  .order('created_at', { ascending: false })
  .limit(50);
```

```typescript src/components/InboxButton.tsx theme={null}
const fetchCount = async () => {
  const { count, error } = await supabase
    .from('inbox_messages')
    .select('id', { count: 'exact', head: true })
    .eq('read', false);

  if (!cancelled && !error && count !== null) {
    setUnreadCount(count);
  }
};
```

## メールの設定を同期する \\

同じストリームで、もう1つの問題も解決できます。ユーザーがメール内の**Unsubscribe**をタップすると、OneSignalはそのユーザーへのメール送信を停止しますが、アプリ自体の「Weekly Email Summary」スイッチはオンのままです。設定画面が実態と食い違い、バックエンドは送信を試み続けることになります。

ストリームに4つのメールイベントを追加すると、これを解決できます。関数はこれらをすべて同じように扱います。OneSignalはこの人に今後メールを送らないため、アプリの設定もそれに合わせてオフにします。

```typescript supabase/functions/inbox-webhook/index.ts theme={null}
const EMAIL_STOP_EVENTS: Record<string, string> = {
  'message.email.unsubscribed': 'unsubscribed',
  'message.email.reported_as_spam': 'reported_as_spam',
  'message.email.bounced': 'bounced',
  'message.email.suppressed': 'suppressed',
};

// ...

const { error: prefErr } = await supabase
  .from('profiles')
  .update({ email_weekly_summary: false })
  .eq('id', profile.id);
```

受信箱がすでに使っているフィールド（`event_kind`、`event_id`、`external_id`）で十分なため、ストリームの本文を変更する必要はありません。

> [!NOTE]
>
> これはアプリをOneSignalに合わせるもので、逆方向ではありません。ユーザーがアプリでメールを再びオンにしても、OneSignalのサブスクリプションは配信停止のままです。再購読させるには、バックエンドからOneSignalのサブスクリプションAPIを呼び出す必要があります。

> [!TIP]
>
> 同じEvent Streamのパターンで、メールの開封、アプリ内メッセージのクリック、SMSの配信など、OneSignalが把握しているあらゆる情報を自社システムと同期できます。

> [card] [Event Streams](https://documentation.onesignal.com/docs/ja/event-streams.md)
>
> ストリームを設定し、イベントを選択する。

> [card] [Event Streamのデータ](https://documentation.onesignal.com/docs/ja/event-streams-data.md)
>
> 本文テンプレートで使用できるすべてのフィールド。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.