メインコンテンツへスキップ
OneSignalのほとんどのガイドは、一度に1つの機能を説明します。このガイドは1つのアプリを最初から最後まで追い、すべてのメッセージング機能がどのように組み込まれたかを、本番環境で動いているコードとともに紹介します。 アプリはClean Beansという、共同生活の家のための掃除当番表アプリです。Expo(React Native)で構築され、データベース、認証、バックエンド関数にSupabaseを使用しています。アプリが送信するすべてのメッセージはOneSignalが処理します。
Clean Beansの3つの画面:ダッシュボード、掃除セッション、週間当番表

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

Clean Beansでできること \

世帯が部屋を追加すると、アプリはそれらを適切な頻度の掃除タスクのリストに変換します。当番表ジェネレーターは、各メンバーの使える時間に合わせてタスクを1週間に割り振ります。メンバーは掃除セッションを実行し、タスクにチェックを入れ、毎日の連続記録を伸ばし、互いにkudosを送り合い、週間ランキングで競います。 掃除は共有され、繰り返し発生し、期限があるため、リマインダー、ソーシャルな更新、カウントダウン、まとめ、コーチングなど、ほぼあらゆる種類のメッセージに適しています。

このガイドの目的 \

次の3つの疑問に答えるために使ってください。
  • どのOneSignal機能がどの用途に合うか? 各ページは、アプリが実現する必要があったことから始まり、それを実現する機能を示します。
  • コードはどこに置くか? アプリに置くもの、バックエンドに置くもの、OneSignalダッシュボードに置くものがあります。各例でどれに当たるかを示します。
  • 何がうまくいかないか? 各ページの警告とメモには、リリースを通じて学んだことが記録されています。collapse_idという設定は試した後に削除しました。その理由は信頼性が高く適切に動作するプッシュで説明しています。

読み方 \

このガイドはトピックごとに1ページのページ群で構成されています。順番に読む必要はありません。SDKのセットアップとユーザーIDはほかのすべての基盤です。それ以降の各ページは独立して読めます。 ほとんどの機能は同じ形式で紹介しています。
  1. ユーザーに見えるもの。通常はスクリーンショット付きです。
  2. 仕組み。誰が何をするかの短い流れです。
  3. コード。アプリから抜粋したものです。各コードブロックのタイトルは、元のファイル名です。
  4. ダッシュボードの設定。OneSignalで設定が必要な機能の場合です。
制限や想定外の挙動は、影響する機能の横に警告やメモとして記載しています。
コードは実際のものですが、識別子はYOUR_ONESIGNAL_APP_IDやYOUR_PROJECT_REFなどのプレースホルダーに置き換えています。長いファイルは重要な行だけに絞っています。// ...だけの行は、コードを省略した箇所を示します。

各要素の関係 \

External IDがこの3つをつなぎます。Clean Beansはサインイン時にExternal IDをSupabaseのユーザーIDに設定します。これにより、バックエンドはすでに保存しているIDを使って誰にでもメッセージを送れます。
Expoアプリ、Supabaseバックエンド、OneSignalダッシュボードを示すアーキテクチャ図

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

機能マップ \

必要なもの \

  • iOSとAndroidのプッシュが設定され、メールとSMSもセットアップ済みのOneSignalアプリ。チャネルのセットアップを参照してください。
  • EAS BuildでビルドされたExpoアプリ。OneSignal SDKにはネイティブコードが必要なため、Expo Goでは不十分です。Expo SDKのセットアップを参照してください。
  • App IDとApp API key。キーとIDを参照してください。
  • スケジュールに従って、またリクエストに応じてコードを実行できるバックエンド。Clean BeansはSupabase Edge Functionsとpg_cronを使用しています。同じパターンはどのバックエンドにも当てはまります。

有効だった原則 \

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

全機能の一覧 \

シークレット \

バックエンド関数はこれらを環境変数から読み取ります。いずれもアプリには含めません。
App API keyはすべてのユーザーにメッセージを送信できます。バックエンドで管理してください。アプリ自体に必要なのはApp IDだけです。