メインコンテンツへスキップ
このページは、1つの実在アプリを最初から最後まで追うサンプルアプリ:OneSignalの完全な統合の一部です。アプリはClean Beansという共同生活の家のための掃除当番表アプリで、Expo(React Native)とSupabaseバックエンドで構築されています。 毎週日曜日、各世帯にその週のまとめメールが届きます。セッション数、タスク数、掃除時間、ランキング、そして各メンバー自身の数字です。
Clean Beansの週次レポートメール

週次レポート:世帯の合計、あなた自身の1週間、ランキング。

興味深い課題はパーソナライズです。世帯の全員が同じランキングを見ますが、各自には自分の名前と統計が表示される必要があります。1人ずつリクエストを送っても実現できますが、もっと良い方法があります。

世帯ごとに1回のリクエストで、1人ずつパーソナライズする \

関数は世帯ごとに1回だけリクエストを送ります。External IDをキーにしたusersオブジェクトを含め、すべてのデータをcustom_dataで渡します。テンプレートは、表示対象の人に合ったエントリを選び出します。
supabase/functions/weekly-report/index.ts
テンプレートでは、1行のLiquidで現在の受信者のデータを選択します。
email-templates/weekly-report.html
以降、userにはその人の統計が入り、message.custom_dataから直接読み取るものは世帯で共通になります。
email-templates/weekly-report.html
2つ目のLiquidの例は、テーブルのマークアップを省いてロジックだけを示すため、テンプレートを簡略化したものです。

サイズの上限内に収める \

メールのcustom_dataの上限は10 KBです。大きな世帯では超える可能性があるため、関数はペイロードのサイズを測り、必要に応じてランキングを削ります。
supabase/functions/weekly-report/index.ts

スケジュールと設定 \

毎週のスケジュールが、毎週日曜日の09:00 UTCに関数を呼び出します。プッシュのリマインダーと同じpg_cronのパターンで、式は0 9 * * 0です。Weekly Email Summaryをオンにしているユーザーだけが対象になります。 ダッシュボードの設定。 Messages > Templatesでメールテンプレートを作成し、HTMLを貼り付け、テンプレートIDをバックエンドのシークレットにコピーします。custom_dataはテンプレートでのみ機能するため、template_idは必須です。

代替手段:Data Feeds \

人ごとのデータをメールに入れる方法はもう1つあり、Clean Beansはそれを使わないことにしました。アプリによってはこちらのほうが適しているため、理解しておく価値があります。 custom_dataでは、送信時にバックエンドがデータをOneSignalにプッシュします。Data Feedでは、各メールが送信される時点でOneSignalがAPIからデータをプルします。送信自体はバックエンドではなくJourneyが開始します。
この項の例は説明用です。Data Feedで週次レポートを作った場合の姿を示したもので、アプリから抜粋したものではありません。
週次レポートを作った場合は次のようになります。
1

1人分の1週間を返すエンドポイントを公開する

バックエンド関数がユーザーIDを受け取り、そのユーザーの統計と世帯のランキングをJSONで返します。
Response from your API
2

ダッシュボードでData Feedを作成する

Settings > Data feedsでフィードにエイリアスを付け、エンドポイントを指定します。URLとヘッダーではLiquidを使えるため、受信者のExternal IDを渡せます。
Data Feed configuration
3

フィードをメールテンプレートに紐付けて読み取る

テンプレートでは、値はdata_feedの後にエイリアスを続けて取得します。
Email template
4

繰り返し実行されるJourneyから送信する

最初のステップに日曜朝の時間枠を置き、再エントリールールを設定したJourneyが、毎週テンプレートを送信します。スケジュールや送信のコードはバックエンドに一切ありません。

どちらを使うか \

バックエンドがすでに送信を決めている場合はcustom_dataを選びます。 週次レポートがまさにそうです。バックエンドはスケジュールで動き、どの世帯がオプトインしているかを把握し、すべての数字を手元に持っているため、データを渡す追加コストはありません。1回のリクエストで世帯全体をカバーでき、保護すべきエンドポイントはなく、失敗は自分のログに表示されます。その代わり、タイミングとオーディエンスはコードで管理することになり、ペイロードには固定のサイズ上限があります。 送信がJourneyに属する場合はData Feedを選びます。 Journeyは、イベントの数日後や待機条件を満たしたときなど、メッセージを送るタイミングを自ら判断します。その時点でバックエンドがデータを提供することはできません。Data Feedはこの隙間を埋め、メッセージングの担当者がデプロイなしでスケジュールの変更、分岐の追加、バリエーションのテストを行えるようにします。その代わり、APIは受信者ごとに1回呼び出され、約0.25秒以内に応答する必要があります。また、各テンプレートで使えるフィードは1つだけで、呼び出しに失敗するとその人には何も届かず、通知もされません。 Clean Beansの決め手はシンプルでした。バックエンドにはすでにデータとスケジュールがあり、ランキングは世帯で共有されるため1人ずつ呼び出すより1回のリクエストのほうがはるかに安く、設定はアプリのデータベースに保存されていてバックエンドが直接確認できるからです。

custom_dataでパーソナライズする

サイズの上限とLiquidでのアクセス方法。

Data feeds

JourneyのメールとSMSにライブデータを取り込む。

Liquid構文の使い方

フィルター、ループ、条件。