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

# サンプルアプリ：アプリ内メッセージ

> サンプルアプリClean Beansが、アプリ内メッセージのトリガーとカスタムHTMLを使って、ヘルプオーバーレイ、許可の事前プロンプト、更新とレビューのプロンプトを実現する方法。

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

アプリ内メッセージは、ユーザーがアプリを使っている間に表示されます。コンテンツ、オーディエンス、スケジュールはOneSignalダッシュボードにあるため、リリースなしで変更できます。Clean Beansは5つの用途に使っています。

| メッセージ | 表示されるタイミング | ターゲティング方法 |
| - | - | - |
| ヘルプオーバーレイ | ユーザーが画面のヘルプボタンをタップしたとき | アプリが設定するトリガー |
| ウォークスルー | ユーザーが画面のガイドツアーを必要とするとき | 同じトリガー |
| プッシュ許可の事前プロンプト | システムの許可ダイアログの前 | ダッシュボードのオーディエンスとスケジュール |
| アプリ更新のプロンプト | ユーザーが古いバージョンを使っているとき | セグメント |
| レビューのプロンプト | ユーザーが連続記録の節目に達したとき | アプリが設定するトリガー |

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

トリガーとは、アプリが設定するキーと値です。それに一致するよう設定されたアプリ内メッセージが表示されます。Clean Beansのすべての画面にはヘッダーにヘルプボタンがあり、画面名を値としてトリガーを1つ設定します。

```typescript src/components/HelpButton.tsx theme={null}
export function HelpButton({ triggerValue }: HelpButtonProps) {
  const handlePress = () => {
    OneSignal.InAppMessages.addTrigger('help_topic', triggerValue);
  };

  return (
    <TouchableOpacity onPress={handlePress} style={styles.button} hitSlop={8}>
      <Ionicons name="help-circle-outline" size={26} color={Colors.white} />
    </TouchableOpacity>
  );
}
```

```typescript app/(tabs)/_layout.tsx theme={null}
<Tabs.Screen
  name="index"
  options={{
    title: 'Dashboard',
    headerRight: () => <HeaderRight helpTopic="dashboard" />,
    tabBarIcon: ({ focused }) => <TabIcon name={focused ? 'home' : 'home-outline'} focused={focused} />,
  }}
/>
```

1つのトリガーキーで13の画面に対応しています。新しい画面にヘルプを追加するには、新しい値のボタンを追加し、ダッシュボードでメッセージを作成するだけです。

![ダッシュボード上に表示されたヘルプオーバーレイのアプリ内メッセージ](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/cleanbeans-help.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=521ce92f66d1df24e99790600813523a)

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

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

![スワイプできるカードで構成されたウォークスルーのアプリ内メッセージ](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/cleanbeans-iam-walkthrough.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=c335375ee2bb79060e97aa945dea644e)

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

## カスタムHTMLメッセージ \\

ヘルプオーバーレイはHTMLで作成しているため、アプリのデザインと完全に一致します。HTMLのアプリ内メッセージは、`OneSignalIamApi`オブジェクトを通じてSDKと通信します。クリック可能なすべての要素には、2つのルールが適用されます。

* クリックが正しく追跡されるよう、一意の`data-onesignal-unique-label`を付けます。
* `OneSignalIamApi`のメソッドを呼び出すリスナーを設定します。通常のリンクは追跡されません。

```html docs/iam-html/help-dashboard.html theme={null}
<button id="got-it" class="cta-btn" data-onesignal-unique-label="dashboard-got-it">Got it</button>

<script>
  document.addEventListener("DOMContentLoaded", function () {
    document.getElementById("got-it").addEventListener("click", function (e) {
      OneSignalIamApi.close(e);
    });
  });
</script>
```

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

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

![通知を有効にするメリットを説明するアプリ内メッセージ](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/cleanbeans-iam-push-prompt.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=18791e9af52a803d41048eba393109f6)

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

```html docs/iam-html/push-permission-prompt.html theme={null}
<script>
  document.addEventListener("DOMContentLoaded", function () {
    document.getElementById("enable-btn").addEventListener("click", function (e) {
      OneSignalIamApi.triggerPushPrompt(e);
    });
    document.getElementById("skip-btn").addEventListener("click", function (e) {
      OneSignalIamApi.close(e);
    });
  });
</script>
```

> [!NOTE]
>
> 事前プロンプトを使う場合は、アプリ起動時の`requestPermission()`呼び出しを削除してください。そうしないとシステムダイアログが先に表示され、事前プロンプトで尋ねることがなくなります。

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

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

![アプリの更新を促すアプリ内メッセージ](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/cleanbeans-iam-app-version.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=f096ce85f566823331171e14312e534d)

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

1つのメッセージで両方のプラットフォームに対応します。スクリプトがデバイスに応じてストアを選び、`openUrl`がクリックを追跡してストアを開き、メッセージを閉じます。

```html docs/iam-html/app-update-prompt.html theme={null}
<script>
  var IOS_URL = "https://apps.apple.com/app/id" + IOS_APP_STORE_ID;
  var ANDROID_URL = "https://play.google.com/store/apps/details?id=" + ANDROID_PACKAGE;

  // One message serves both platforms: pick the store from the device.
  var isAndroid = /android/i.test(navigator.userAgent);
  var storeUrl = isAndroid ? ANDROID_URL : IOS_URL;

  document.addEventListener("DOMContentLoaded", function () {
    document.getElementById("update-btn").addEventListener("click", function (e) {
      // openUrl tracks the click, opens the store and closes the message
      OneSignalIamApi.openUrl(e, storeUrl);
    });
    document.getElementById("later-btn").addEventListener("click", function (e) {
      OneSignalIamApi.close(e);
    });
  });
</script>
```

あいさつ文はタグを使い、タグがないユーザー向けのフォールバックを用意しています。

```html docs/iam-html/app-update-prompt.html theme={null}
<p>Hey {{ user_name | default: "there" }}, you're on an older version</p>
```

**ダッシュボードの設定。** **App version**が現在のバージョン未満というフィルターでセグメントを作成し、メッセージのオーディエンスとして使います。リリースのたびにフィルターを更新してください。

> [!NOTE]
>
> タグの置換は、HTMLアプリ内メッセージのテキストと属性では機能しますが、`script`タグ内では機能しません。

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

アプリストアでの評価を依頼するのに適したタイミングは、何かがうまくいった直後です。Clean Beansは、掃除セッションによって連続記録が7日の倍数に達したときに依頼します。

ネイティブの評価シートはアプリ自身にしか開けないため、これはタップでアプリ内のコードを実行する必要がある唯一のアプリ内メッセージです。

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

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

```typescript src/lib/reviewPrompt.ts theme={null}
export async function maybeAskForReview(streak: number): Promise<void> {
  try {
    if (streak <= 0 || streak % STREAK_MILESTONE_DAYS !== 0) return;

    // A second session on the same day leaves the streak unchanged —
    // don't ask twice for the same milestone.
    const lastPrompted = await AsyncStorage.getItem(LAST_PROMPTED_STREAK_KEY);
    if (lastPrompted === String(streak)) return;
    await AsyncStorage.setItem(LAST_PROMPTED_STREAK_KEY, String(streak));

    OneSignal.InAppMessages.addTrigger(REVIEW_TRIGGER_KEY, REVIEW_TRIGGER_VALUE);
    console.log('[reviewPrompt] Trigger set at streak', streak);
  } catch (e) {
    console.warn('[reviewPrompt] maybeAskForReview error:', e);
  }
}
```

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

`addClickName`はアプリのクリックリスナーに名前を渡します。メッセージは閉じないため、その後スクリプトで閉じます。

```html docs/iam-html/review-prompt.html theme={null}
<script>
  document.addEventListener("DOMContentLoaded", function () {
    var autoCloseBtn = document.getElementById("auto-close-btn");

    document.getElementById("rate-btn").addEventListener("click", function (e) {
      // Passes the click name "review" to the app's In-App Message click
      // listener, which opens the native rating sheet. addClickName does not
      // close the message, so close it straight afterwards.
      OneSignalIamApi.addClickName(e, "review");
      setTimeout(function () { autoCloseBtn.click(); }, 300);
    });
    autoCloseBtn.addEventListener("click", function (e) {
      OneSignalIamApi.close(e);
    });
    document.getElementById("later-btn").addEventListener("click", function (e) {
      OneSignalIamApi.close(e);
    });
  });
</script>
```

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

クリックリスナーが名前を確認し、シートの表示をシステムに要求します。

```typescript src/lib/reviewPrompt.ts theme={null}
export function handleReviewClick(event: InAppMessageClickEvent): void {
  if (event.result.actionId !== REVIEW_ACTION_ID) return;

  // Give the In-App Message a moment to close before presenting the sheet
  setTimeout(async () => {
    try {
      // false on TestFlight builds and on the web
      if (await StoreReview.isAvailableAsync()) {
        await StoreReview.requestReview();
      } else {
        console.log('[reviewPrompt] Store review not available on this build');
      }
    } catch (e) {
      console.warn('[reviewPrompt] requestReview error:', e);
    } finally {
      // Clear the trigger so the message is not re-evaluated this app session
      OneSignal.InAppMessages.removeTrigger(REVIEW_TRIGGER_KEY);
    }
  }, 800);
}
```

```typescript app/_layout.tsx theme={null}
OneSignal.InAppMessages.addEventListener('click', handleReviewClick);
```

![レビューを依頼するアプリ内メッセージ](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/cleanbeans-review-prompt.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=90dde058450240f49d42e76402ed28ce)

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

**ダッシュボードの設定。** トリガーが`ask_for_review` **is** `show`のHTMLアプリ内メッセージを作成します。表示頻度は17週間に最大1回になるようスケジュールします。

> [!WARNING]
>
> Appleは評価シートを1ユーザーにつき年3回までしか表示せず、Googleにも独自の制限があるため、ボタンをタップしても何も表示されないことがあります。TestFlightビルドではシートは表示されません。このフローはApp Storeビルドでテストしてください。

> [card] [アプリ内トリガー](https://documentation.onesignal.com/docs/ja/iam-triggers.md)
>
> トリガーの種類と組み合わせ方。

> [card] [HTMLアプリ内メッセージ](https://documentation.onesignal.com/docs/ja/design-your-in-app-message-with-html.md)
>
> 独自のHTMLでメッセージをデザインする。

> [card] [アプリ内JavaScript API](https://documentation.onesignal.com/docs/ja/in-app-message-api.md)
>
> すべての`OneSignalIamApi`メソッド。


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