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

# サンプルアプリ：OneSignalの完全な統合

> 実在のアプリClean Beansを通して、ExpoとSupabaseでプッシュ、アプリ内メッセージ、メール、SMS、Live Activities、Event Streamsがどのように連携するかを確認します。

OneSignalのほとんどのガイドは、一度に1つの機能を説明します。このガイドは1つのアプリを最初から最後まで追い、すべてのメッセージング機能がどのように組み込まれたかを、本番環境で動いているコードとともに紹介します。

アプリは**Clean Beans**という、共同生活の家のための掃除当番表アプリです。Expo（React Native）で構築され、データベース、認証、バックエンド関数にSupabaseを使用しています。アプリが送信するすべてのメッセージはOneSignalが処理します。

![Clean Beansの3つの画面：ダッシュボード、掃除セッション、週間当番表](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/cleanbeans-dashboard-session-rota.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=f8fc7eac8e69faea6aece66f73c2d820)

Clean Beans：ダッシュボード、掃除セッション、週間当番表。

## Clean Beansでできること \\

世帯が部屋を追加すると、アプリはそれらを適切な頻度の掃除タスクのリストに変換します。当番表ジェネレーターは、各メンバーの使える時間に合わせてタスクを1週間に割り振ります。メンバーは掃除セッションを実行し、タスクにチェックを入れ、毎日の連続記録を伸ばし、互いにkudosを送り合い、週間ランキングで競います。

掃除は共有され、繰り返し発生し、期限があるため、リマインダー、ソーシャルな更新、カウントダウン、まとめ、コーチングなど、ほぼあらゆる種類のメッセージに適しています。

## このガイドの目的 \\

次の3つの疑問に答えるために使ってください。

* **どのOneSignal機能がどの用途に合うか？** 各ページは、アプリが実現する必要があったことから始まり、それを実現する機能を示します。
* **コードはどこに置くか？** アプリに置くもの、バックエンドに置くもの、OneSignalダッシュボードに置くものがあります。各例でどれに当たるかを示します。
* **何がうまくいかないか？** 各ページの警告とメモには、リリースを通じて学んだことが記録されています。`collapse_id`という設定は試した後に削除しました。その理由は[信頼性が高く適切に動作するプッシュ](https://documentation.onesignal.com/docs/ja/example-full-integration-reliable-push.md)で説明しています。

## 読み方 \\

このガイドはトピックごとに1ページのページ群で構成されています。順番に読む必要はありません。[SDKのセットアップとユーザーID](https://documentation.onesignal.com/docs/ja/example-full-integration-sdk-setup.md)はほかのすべての基盤です。それ以降の各ページは独立して読めます。

ほとんどの機能は同じ形式で紹介しています。

1. **ユーザーに見えるもの**。通常はスクリーンショット付きです。
2. **仕組み**。誰が何をするかの短い流れです。
3. **コード**。アプリから抜粋したものです。各コードブロックのタイトルは、元のファイル名です。
4. **ダッシュボードの設定**。OneSignalで設定が必要な機能の場合です。

制限や想定外の挙動は、影響する機能の横に警告やメモとして記載しています。

> [!NOTE]
>
> コードは実際のものですが、識別子は`YOUR_ONESIGNAL_APP_ID`や`YOUR_PROJECT_REF`などのプレースホルダーに置き換えています。長いファイルは重要な行だけに絞っています。`// ...`だけの行は、コードを省略した箇所を示します。

## 各要素の関係 \\

| 場所 | 担当すること | 例 |
| - | - | - |
| **Expoアプリ** | デバイスまたはサインイン中のユーザーを必要とするすべて | SDKの初期化、許可のリクエスト、ユーザーの識別、タグ、カスタムイベント、アプリ内メッセージのトリガー、タップの処理 |
| **Supabaseバックエンド** | スケジュールまたはデータの変更によってトリガーされるすべて | リマインダー、ソーシャルプッシュ、週次メール、SMSコードと招待、Live Activitiesの開始、Event Stream Webhookの受信 |
| **OneSignalダッシュボード** | リリースなしで変更したいコンテンツとターゲティング | アプリ内メッセージ、メールテンプレート、セグメント、Conversion Metrics、Event Stream |

**External ID**がこの3つをつなぎます。Clean Beansはサインイン時にExternal IDをSupabaseのユーザーIDに設定します。これにより、バックエンドはすでに保存しているIDを使って誰にでもメッセージを送れます。

![Expoアプリ、Supabaseバックエンド、OneSignalダッシュボードを示すアーキテクチャ図](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/clean-beans-architecture.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=b6d5655991cdf5b4de0645b9d7f9cd95)

アプリ、バックエンド、ダッシュボードはそれぞれOneSignalと通信します。External IDがそれらを1人のユーザーに結び付けます。

## 機能マップ \\

| アプリに必要だったこと | OneSignalの機能 | ページ |
| - | - | - |
| 各デバイスの持ち主を把握する | External ID、メールサブスクリプション | [SDKのセットアップとユーザーID](https://documentation.onesignal.com/docs/ja/example-full-integration-sdk-setup.md) |
| パーソナライズとセグメント化 | タグ、カスタムイベント、Conversion Metrics | [タグ、カスタムイベント、Conversion Metrics](https://documentation.onesignal.com/docs/ja/example-full-integration-tags-events.md) |
| タスクをリマインドする | スケジュールされた関数からのCreate message API | [バックエンドからプッシュを送信する](https://documentation.onesignal.com/docs/ja/example-full-integration-backend-push.md) |
| 同居人に出来事を伝える | アプリとデータベースのイベントからのCreate message API | [バックエンドからプッシュを送信する](https://documentation.onesignal.com/docs/ja/example-full-integration-backend-push.md) |
| リマインダーを二重送信しない | べき等キー | [信頼性が高く適切に動作するプッシュ](https://documentation.onesignal.com/docs/ja/example-full-integration-reliable-push.md) |
| プッシュごとに適切な動作をさせる | 有効期限、グループ化、割り込みレベル、バッジ | [信頼性が高く適切に動作するプッシュ](https://documentation.onesignal.com/docs/ja/example-full-integration-reliable-push.md) |
| タップやリンクから正しい画面を開く | クリックリスナー、ディープリンク、Universal Links | [ディープリンクと通知のクリック](https://documentation.onesignal.com/docs/ja/example-full-integration-deep-links.md) |
| 通知から直接操作できるようにする | アクションボタン、スケジュール配信 | [ディープリンクと通知のクリック](https://documentation.onesignal.com/docs/ja/example-full-integration-deep-links.md) |
| アプリ内でユーザーを案内・促す | トリガーとカスタムHTMLを使ったアプリ内メッセージ | [アプリ内メッセージ](https://documentation.onesignal.com/docs/ja/example-full-integration-in-app-messages.md) |
| 週次のまとめを送る | `custom_data`を使ったメールテンプレート | [custom\_dataを使った週次メール](https://documentation.onesignal.com/docs/ja/example-full-integration-weekly-email.md) |
| 電話番号がユーザーのものか証明する | 電話番号への直接のSMS、SMSサブスクリプション | [SMS：認証コードと招待](https://documentation.onesignal.com/docs/ja/example-full-integration-sms.md) |
| アプリを持っていない人を招待する | 連絡先への直接のSMSとメール | [SMS：認証コードと招待](https://documentation.onesignal.com/docs/ja/example-full-integration-sms.md) |
| ロック画面にカウントダウンを表示する | Live Activities | [Live Activities](https://documentation.onesignal.com/docs/ja/example-full-integration-live-activities.md) |
| アプリ内に通知履歴を残す | Event Streams | [Event Streamsを使った通知受信箱](https://documentation.onesignal.com/docs/ja/example-full-integration-inbox.md) |
| 配信停止とアプリの設定を同期する | Event Streams（メールイベント） | [Event Streamsを使った通知受信箱](https://documentation.onesignal.com/docs/ja/example-full-integration-inbox.md) |

## 必要なもの \\

* iOSとAndroidのプッシュが設定され、メールとSMSもセットアップ済みのOneSignalアプリ。[チャネルのセットアップ](https://documentation.onesignal.com/docs/ja/channel-setup.md)を参照してください。
* EAS BuildでビルドされたExpoアプリ。OneSignal SDKにはネイティブコードが必要なため、Expo Goでは不十分です。[Expo SDKのセットアップ](https://documentation.onesignal.com/docs/ja/react-native-expo-sdk-setup.md)を参照してください。
* App IDとApp API key。[キーとID](https://documentation.onesignal.com/docs/ja/keys-and-ids.md)を参照してください。
* スケジュールに従って、またリクエストに応じてコードを実行できるバックエンド。Clean BeansはSupabase Edge Functionsと`pg_cron`を使用しています。同じパターンはどのバックエンドにも当てはまります。

## 有効だった原則 \\

* **最初にExternal IDを設定する。** ここで紹介するほぼすべての機能がExternal IDに依存しています。バックエンドがすでに保存しているIDを使ってください。
* **各処理を適切な場所に置く。** アプリはデバイスとサインイン中のユーザーを扱います。バックエンドはスケジュールとデータの変更を扱います。ダッシュボードには、リリースなしで変更したいものを置きます。
* **送信前に確認する。** バックエンドからの送信では毎回、ユーザーの設定を確認し、伝える価値のある内容があることを確かめます。
* **スケジュール送信を再実行可能にする。** 種類、受信者、日付から作ったべき等キーにより、再試行しても何も起こらなくなります。
* **URLではなく種類でルーティングする。** `data.type`フィールドがあれば、画面が移動しても古い通知が正しく動作し続けます。
* **呼び出し元の情報を検証する。** メッセージを送信する関数は、まず自分のデータベースで事実を確認する必要があります。

## 全機能の一覧 \\

| 機能 | チャネル | トリガー | 実行場所 | 主なファイル |
| - | - | - | - | - |
| SDKの初期化と許可 | プッシュ | アプリの起動 | アプリ | `app/_layout.tsx` |
| ユーザーID | すべて | サインインとサインアウト | アプリ | `app/_layout.tsx` |
| メールサブスクリプション | メール | サインイン | アプリ | `src/lib/onesignalSync.ts` |
| オプトインと設定 | プッシュ、メール | 設定画面 | アプリとデータベース | `app/notification-settings.tsx` |
| タグ | すべて | サインイン、セッション、プロフィール編集 | アプリ | `src/lib/onesignalSync.ts` |
| カスタムイベント | すべて | セッションの開始と終了 | アプリ | `src/lib/onesignalSync.ts` |
| Conversion Metrics | すべて | セッションの終了 | ダッシュボード | |
| デイリーダイジェスト | プッシュ | 1時間ごとのスケジュール | バックエンド | `supabase/functions/send-daily-digest/` |
| 期限切れリマインダー | プッシュ | 1時間ごとのスケジュール | バックエンド | `supabase/functions/send-overdue-reminders/` |
| 掃除リマインダー | プッシュ | 1時間ごとのスケジュール | バックエンド | `supabase/functions/send-cleaning-reminder/` |
| セッション完了 | プッシュ | アプリからの呼び出し | バックエンド | `supabase/functions/session-completed/` |
| Kudos | プッシュ | アプリからの呼び出し | バックエンド | `supabase/functions/send-kudos/` |
| 参加承認 | プッシュ | データベーストリガー | バックエンド | `supabase/functions/join-approved/` |
| べき等な送信 | プッシュ、メール | すべてのスケジュール送信 | バックエンド | `supabase/functions/_shared/idempotency.ts` |
| 配信プロファイル | プッシュ | すべてのプッシュ | バックエンド | `supabase/functions/_shared/delivery.ts` |
| バッジ | プッシュ | タスクのプッシュ | バックエンド | `supabase/functions/send-daily-digest/` |
| タップのルーティング | プッシュ | プッシュのタップ | アプリ | `app/_layout.tsx` |
| アクションボタン | プッシュ | プッシュのボタンのタップ | バックエンドとアプリ | `supabase/functions/_shared/buttons.ts`、`src/lib/pushActions.ts` |
| スヌーズしたリマインダー | プッシュ | スヌーズボタン | バックエンド | `supabase/functions/snooze-reminder/` |
| リンクの書き換え | リンク | URLからのアプリ起動 | アプリ | `app/+native-intent.tsx` |
| Universal LinksとApp Links | リンク | Webリンクのタップ | アプリとWebサイト | `app.json`、`website/.well-known/` |
| ヘルプオーバーレイとウォークスルー | アプリ内 | ヘルプボタン | アプリとダッシュボード | `src/components/HelpButton.tsx` |
| プッシュ許可の事前プロンプト | アプリ内 | ダッシュボードのオーディエンス | ダッシュボード | `docs/iam-html/push-permission-prompt.html` |
| アプリ更新のプロンプト | アプリ内 | 古いアプリバージョン | ダッシュボード | `docs/iam-html/app-update-prompt.html` |
| レビューのプロンプト | アプリ内 | 連続記録の節目 | アプリとダッシュボード | `src/lib/reviewPrompt.ts` |
| 週次レポート | メール | 毎週のスケジュール | バックエンドとダッシュボード | `supabase/functions/weekly-report/` |
| SMSサブスクリプション | SMS | 電話番号の認証、サインイン | アプリ | `src/lib/phone.ts` |
| 電話番号の認証コード | SMS | アプリからの呼び出し | バックエンド | `supabase/functions/send-otp/`、`supabase/functions/verify-otp/` |
| 世帯への招待 | SMS、メール | アプリからの呼び出し | バックエンド | `supabase/functions/send-invite/` |
| 連続記録の警告 | Live Activity | 1時間ごとのスケジュール | バックエンドとウィジェット | `supabase/functions/streak-warning/` |
| 掃除リマインダー | Live Activity | 1時間ごとのスケジュール | バックエンドとウィジェット | `supabase/functions/cleaning-activity/` |
| 通知受信箱 | Event Streams | プッシュの送信またはクリックごと | バックエンドとアプリ | `supabase/functions/inbox-webhook/` |
| メール設定の同期 | Event Streams | メールの配信停止、バウンス、スパム報告 | バックエンド | `supabase/functions/inbox-webhook/` |

## シークレット \\

バックエンド関数はこれらを環境変数から読み取ります。いずれもアプリには含めません。

```bash theme={null}
supabase secrets set ONESIGNAL_APP_ID=YOUR_ONESIGNAL_APP_ID
supabase secrets set ONESIGNAL_REST_API_KEY=YOUR_APP_API_KEY
supabase secrets set ONESIGNAL_WEEKLY_TEMPLATE_ID=YOUR_EMAIL_TEMPLATE_ID
supabase secrets set INBOX_WEBHOOK_SECRET=YOUR_SHARED_SECRET
supabase secrets set OTP_HASH_SECRET=A_LONG_RANDOM_STRING    # key for hashing SMS verification codes

# Optional
supabase secrets set ONESIGNAL_SMS_FROM=YOUR_SMS_SENDER      # if no default sender is set in the dashboard
```

> [!WARNING]
>
> App API keyはすべてのユーザーにメッセージを送信できます。バックエンドで管理してください。アプリ自体に必要なのはApp IDだけです。


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