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

# サンプルアプリ：SDKのセットアップとユーザーID

> サンプルアプリClean BeansがExpoにOneSignal SDKをインストールし、External IDで各デバイスをユーザーに結び付け、メールを追加する方法。

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

ほかのすべては、次の4点が正しく設定されていることを前提とします。SDKがインストールされていること、アプリの起動時にSDKが起動すること、各デバイスがユーザーに結び付いていること、そしてユーザーが受け取る内容を管理できることです。

## Expoプラグインでインストールする \\

`onesignal-expo-plugin`は、ビルド時にiOSとAndroidのネイティブプロジェクトを設定します。画像、バッジ、配信確認のためにOneSignalが必要とするプッシュのcapability、App Group、Notification Service Extensionを追加します。

```json app.json theme={null}
{
  "expo": {
    "plugins": [
      ["onesignal-expo-plugin", { "mode": "production" }],
      "expo-router",
      "./plugins/withLiveActivityWidget"
    ],
    "ios": {
      "bundleIdentifier": "com.onesignal.cleaningapp",
      "infoPlist": {
        "UIBackgroundModes": ["remote-notification"],
        "NSSupportsLiveActivities": true
      },
      "entitlements": {
        "aps-environment": "production",
        "com.apple.security.application-groups": [
          "group.com.onesignal.cleaningapp.onesignal"
        ]
      }
    }
  }
}
```

## ルートで一度だけ初期化する \\

Clean BeansはルートレイアウトでOneSignalを初期化するため、起動のたびに、どの画面が表示されるよりも前に一度だけ実行されます。

```typescript app/_layout.tsx theme={null}
// Verbose logging is for debugging during the beta. Remove it, or lower
// the level, before a public release.
OneSignal.Debug.setLogLevel(LogLevel.Verbose);
OneSignal.initialize('YOUR_ONESIGNAL_APP_ID');
OneSignal.Notifications.requestPermission(true);
```

> [!TIP]
>
> 初回起動時に許可をリクエストするのが最も簡単な方法です。先にメリットを説明したい場合は、システムのプロンプトの前にアプリ内メッセージを表示します。Clean Beansには既製のものがあります。[プッシュ許可の事前プロンプト](https://documentation.onesignal.com/docs/ja/example-full-integration-in-app-messages.md#push-permission-pre-prompt)を参照してください。

## 各デバイスをユーザーに結び付ける \\

ユーザーがサインインすると、アプリはSupabaseのユーザーIDを`OneSignal.login()`に渡します。このIDがExternal IDになります。サインアウトすると、`logout()`がデバイスの紐付けを解除し、次にサインインした人が前のユーザーのメッセージを引き継がないようにします。

```typescript app/_layout.tsx theme={null}
// Link OneSignal identity to authenticated user and sync timezone
//
// Wait until the saved session has been restored. On a cold start `user`
// is null for a moment while it loads; calling logout() then, followed by
// login() a moment later, can leave this device's push subscription on an
// anonymous OneSignal user, so pushes sent to the External ID never reach
// the phone. logout() is only called on a real sign-out.
const wasSignedIn = useRef(false);
useEffect(() => {
  if (loading) return;

  if (user) {
    wasSignedIn.current = true;
    OneSignal.login(user.id);
    syncDeviceTimezone();
    // Add email subscription and sync data tags to OneSignal
    if (user.email) syncOneSignalEmail(user.email);
    // Add the SMS subscription if the user has a verified phone number
    syncOneSignalSms();
    syncOneSignalTags();
  } else if (wasSignedIn.current) {
    wasSignedIn.current = false;
    OneSignal.logout();
  }
}, [user, loading]);
```

> [!WARNING]
>
> どちらのメソッドを呼び出す場合も、保存されたセッションが読み込まれるまで待ってください。コールドスタート時には、サインイン中のユーザーが一瞬不明になります。その瞬間にアプリが`logout()`を呼び、直後に`login()`を呼ぶと、デバイスのプッシュサブスクリプションが匿名ユーザーに残り、External ID宛てのプッシュが端末に届かなくなることがあります。`logout()`は実際にサインアウトしたときだけ呼び出してください。

このガイドでのバックエンドからの送信はすべて、この1回の呼び出しによって可能になります。ユーザーのデータベースIDを知っている関数は、そのユーザーのデバイスについて何も知らなくてもメッセージを送れます。

## メールチャネルを追加する \\

アプリは登録時から各ユーザーのメールアドレスを把握しているため、サインイン時にそれをメールサブスクリプションとして登録します。OneSignalは同じアドレスでの重複した呼び出しを無視します。

```typescript src/lib/onesignalSync.ts theme={null}
export function syncOneSignalEmail(email: string): void {
  try {
    if (!email) return;
    OneSignal.User.addEmail(email);
    console.log('[onesignalSync] Email subscription added');
  } catch (e) {
    console.warn('[onesignalSync] syncOneSignalEmail error:', e);
  }
}
```

SMSも同じように`addSms()`で追加しますが、番号の認証が済んでからに限ります。[SMS：認証コードと招待](https://documentation.onesignal.com/docs/ja/example-full-integration-sms.md)を参照してください。

## 受け取る内容をユーザーが管理できるようにする \\

通知設定画面には、マスタースイッチと、メッセージの種類ごとのスイッチがあります。

![マスタートグルと種類ごとのトグルがある通知設定画面](https://mintcdn.com/onesignal/XdN288-p34EfpfHk/images/tutorials/cleanbeans-notifications.png?fit=max\&auto=format\&n=XdN288-p34EfpfHk\&q=85\&s=57fef32f8987a51e7bdf8c40a6273087)

通知設定：マスタースイッチ、種類ごとのスイッチ、毎日のリマインダー時刻。

マスタースイッチはプッシュサブスクリプションに対して`optOut()`と`optIn()`を呼び出すため、OneSignalはそのデバイスへの配信を停止・再開します。

```typescript app/notification-settings.tsx theme={null}
const handlePushMasterToggle = async (enabled: boolean) => {
  try {
    if (enabled) {
      OneSignal.User.pushSubscription.optIn();
    } else {
      OneSignal.User.pushSubscription.optOut();
    }
  } catch (e) {
    console.warn('OneSignal subscription toggle failed:', e);
  }
  save({ ...prefs, pushEnabled: enabled });
};
```

各スイッチはユーザーのプロフィール行にも保存されます。バックエンドは送信前にこれらの列を読み取ります。これにより種類ごとの設定が適用されます。

```typescript src/lib/database.ts theme={null}
  const { error } = await supabase
    .from('profiles')
    .update({
      notifications_enabled: prefs.pushEnabled,
      push_daily_reminders: prefs.pushDailyReminders,
      push_streak_reminders: prefs.pushStreakReminders,
      push_cleaning_done: prefs.pushCleaningDone,
      push_leaderboard_updates: prefs.pushLeaderboardUpdates,
      push_upcoming_cleaning: prefs.pushUpcomingCleaning,
      push_overdue_reminders: prefs.pushOverdueReminders,
      email_weekly_summary: prefs.emailWeeklySummary,
      notification_hour: prefs.notificationHour,
      timezone: prefs.timezone,
    })
    .eq('id', user.id);
```

> [!NOTE]
>
> 設定を自分のデータベースに保存し、送信のたびに確認すると、ロジックを1か所にまとめられます。別の方法として、設定をタグとして保存し、OneSignalでタグによって絞り込むこともできます。この方法はセグメントに送信する場合に適しています。Clean Beansは特定のユーザーに送信するため、データベースを確認するほうが簡単です。

> [card] [モバイルSDKリファレンス](https://documentation.onesignal.com/docs/ja/mobile-sdk-reference.md)
>
> このガイドで使用するすべてのクライアントメソッド。

> [card] [ユーザーとExternal ID](https://documentation.onesignal.com/docs/ja/users.md)
>
> IDがチャネルとデバイスをまたいでサブスクリプションを結び付ける仕組み。


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