メインコンテンツへスキップ
このページは、1つの実在アプリを最初から最後まで追うサンプルアプリ:OneSignalの完全な統合の一部です。アプリはClean Beansという共同生活の家のための掃除当番表アプリで、Expo(React Native)とSupabaseバックエンドで構築されています。 アプリ内メッセージは、ユーザーがアプリを使っている間に表示されます。コンテンツ、オーディエンス、スケジュールはOneSignalダッシュボードにあるため、リリースなしで変更できます。Clean Beansは5つの用途に使っています。

トリガー:タイミングはアプリが決める \

トリガーとは、アプリが設定するキーと値です。それに一致するよう設定されたアプリ内メッセージが表示されます。Clean Beansのすべての画面にはヘッダーにヘルプボタンがあり、画面名を値としてトリガーを1つ設定します。
src/components/HelpButton.tsx
app/(tabs)/_layout.tsx
1つのトリガーキーで13の画面に対応しています。新しい画面にヘルプを追加するには、新しい値のボタンを追加し、ダッシュボードでメッセージを作成するだけです。
ダッシュボード上に表示されたヘルプオーバーレイのアプリ内メッセージ

ダッシュボードのヘルプボタンをタップするとヘルプオーバーレイが表示されます。

ダッシュボードの設定。 Messages > In-Appで、トリガーがhelp_topic is dashboardのメッセージを作成し、画面ごとに繰り返します。複数ステップのウォークスルーは、同じトリガーとカルーセルレイアウトを使います。
スワイプできるカードで構成されたウォークスルーのアプリ内メッセージ

カードのカルーセルとして作成した複数ステップのウォークスルー。

カスタムHTMLメッセージ \

ヘルプオーバーレイはHTMLで作成しているため、アプリのデザインと完全に一致します。HTMLのアプリ内メッセージは、OneSignalIamApiオブジェクトを通じてSDKと通信します。クリック可能なすべての要素には、2つのルールが適用されます。
  • クリックが正しく追跡されるよう、一意のdata-onesignal-unique-labelを付けます。
  • OneSignalIamApiのメソッドを呼び出すリスナーを設定します。通常のリンクは追跡されません。
docs/iam-html/help-dashboard.html

プッシュ許可の事前プロンプト \

システムの許可ダイアログは一度しか表示できません。先にアプリ内メッセージを表示すれば、ユーザーが何を受け取れるかを説明でき、Enable notificationsをタップした人だけがシステムダイアログを目にします。
通知を有効にするメリットを説明するアプリ内メッセージ

システムダイアログの前に、事前プロンプトがメリットを説明します。

docs/iam-html/push-permission-prompt.html
事前プロンプトを使う場合は、アプリ起動時のrequestPermission()呼び出しを削除してください。そうしないとシステムダイアログが先に表示され、事前プロンプトで尋ねることがなくなります。

アプリ更新のプロンプト \

新しいバージョンがリリースされると、古いバージョンのユーザーに更新を促すプロンプトが表示されます。このメッセージにはアプリ側のコードは一切不要です。オーディエンスは、古いアプリバージョンを使っているユーザーのセグメントです。
アプリの更新を促すアプリ内メッセージ

古いバージョンのユーザーにだけ表示される更新プロンプト。

1つのメッセージで両方のプラットフォームに対応します。スクリプトがデバイスに応じてストアを選び、openUrlがクリックを追跡してストアを開き、メッセージを閉じます。
docs/iam-html/app-update-prompt.html
あいさつ文はタグを使い、タグがないユーザー向けのフォールバックを用意しています。
docs/iam-html/app-update-prompt.html
ダッシュボードの設定。 App versionが現在のバージョン未満というフィルターでセグメントを作成し、メッセージのオーディエンスとして使います。リリースのたびにフィルターを更新してください。
タグの置換は、HTMLアプリ内メッセージのテキストと属性では機能しますが、scriptタグ内では機能しません。

レビューのプロンプト:クリックをアプリに渡す \

アプリストアでの評価を依頼するのに適したタイミングは、何かがうまくいった直後です。Clean Beansは、掃除セッションによって連続記録が7日の倍数に達したときに依頼します。 ネイティブの評価シートはアプリ自身にしか開けないため、これはタップでアプリ内のコードを実行する必要がある唯一のアプリ内メッセージです。
1

アプリが連続記録の節目でトリガーを設定する

掃除の邪魔にならないようセッション画面が閉じるまで待ち、最後に依頼した節目を記憶しておきます。
src/lib/reviewPrompt.ts
2

メッセージがクリック名をアプリに返す

addClickNameはアプリのクリックリスナーに名前を渡します。メッセージは閉じないため、その後スクリプトで閉じます。
docs/iam-html/review-prompt.html
3

アプリがネイティブの評価シートを開く

クリックリスナーが名前を確認し、シートの表示をシステムに要求します。
src/lib/reviewPrompt.ts
app/_layout.tsx
レビューを依頼するアプリ内メッセージ

レビューを依頼するアプリ内メッセージ。

ダッシュボードの設定。 トリガーがask_for_review is showのHTMLアプリ内メッセージを作成します。表示頻度は17週間に最大1回になるようスケジュールします。
Appleは評価シートを1ユーザーにつき年3回までしか表示せず、Googleにも独自の制限があるため、ボタンをタップしても何も表示されないことがあります。TestFlightビルドではシートは表示されません。このフローはApp Storeビルドでテストしてください。

アプリ内トリガー

トリガーの種類と組み合わせ方。

HTMLアプリ内メッセージ

独自のHTMLでメッセージをデザインする。

アプリ内JavaScript API

すべてのOneSignalIamApiメソッド。