Skip to main content
AIコーディングアシスタントを使用していますか? AI駆動のインストールには、次のプロンプトを使用してください:
Expo Goの制限: プッシュ通知はExpo Goでは動作しません。OneSignalの機能をテストするには、開発ビルドを作成する必要があります。

要件

iOS要件
  • Xcode 14+を搭載したmacOS(セットアップ手順ではXcode 16.2を使用)
  • iOS 12+、iPadOS 12+を搭載したデバイス、またはiOS 16.2+を実行しているXcodeシミュレーター
  • CocoaPods 1.16.2+
Android要件
  • Android 7.0+デバイスまたはGoogle Play Store(Services)がインストールされたエミュレーター

OneSignalアプリとプラットフォームを設定

サポートするプラットフォーム(Apple(APNs)、Google(FCM)、Huawei(HMS)、Amazon(ADM))でOneSignalアプリを設定します。
組織がすでにOneSignalアカウントを持っている場合は、組織への招待をリクエストしてください。それ以外の場合は、無料アカウントにサインアップして開始してください。
1

アプリを作成または選択

New App/Website をクリックして新しいアプリを作成するか、Settings > Push & In-App で既存のアプリにプラットフォームを追加します。設定するプラットフォームを選択し、Next: Configure Your Platform をクリックします。
組織名、アプリ名、チャネル選択を含む新しいアプリセットアップフローを表示するOneSignalダッシュボード

最初のOneSignalアプリ、組織、チャネルのセットアップ。

2

プラットフォーム認証情報を設定

プラットフォームの認証情報を入力します:認証情報を入力した後、Save & Continue をクリックします。
3

App IDを保存してSDKをインストール

App ID は最終画面に表示されます。コピーして保存してください — SDKを初期化するときに必要です。SDKプラットフォームを選択し、セットアップガイドに従います。
セットアップ後のApp IDとチーム招待オプションを表示するOneSignalダッシュボード

App IDを保存して追加のチームメンバーを招待します。


SDKセットアップ

1. SDKを追加する

Expo CLIを使用してOneSignal Expoプラグインをインストールします。
npm
プロジェクトにreact-native-onesignalパッケージを追加します。

2. プラグインを構成する

app.json(またはapp.config.js / app.config.ts)を開きます。次の設定を含める必要があります。 必須設定
string
必須
アプリのバンドル識別子。OneSignalアプリで設定されているp8またはp12認証と一致する必要があります。
object
必須
UIBackgroundModesキーを["remote-notification"]に設定して含める必要があります。
object
必須
プッシュ通知に必要なiOSエンタイトルメント。
  • aps-environmentをテスト用に"development"に、TestFlightおよびApp Storeビルド用に"production"に設定します。
プラグイン[onesignal-expo-plugin]をプラグイン配列の先頭に追加してください。配列の最初のプラグインである必要があります。これにより、OneSignal/OneSignal.h file not foundエラーを防ぐことができます。

オプション: 位置情報モジュールを無効にする

アプリが OneSignal.Location を使用しない場合は、OneSignal Expo プラグイン props で disableLocationtrue に設定します。このオプションには react-native-onesignal 5.5.1 以降が必要です。プラグインはネイティブ依存関係の解決を構成し、react-native-onesignal が位置情報モジュールを除外するようにします。iOS では、プラグインが CocoaPods 解決時に使用される Podfile の環境設定を書き込みます。Android では、プラグインが生成された Gradle properties に onesignal.disableLocation=true を書き込みます。
生成された iOS の Podfile で Notification Service Extension または Live Activity widget ターゲットに明示的に OneSignalXCFramework が宣言されている場合は、OneSignalXCFramework/OneSignalOneSignalXCFramework/OneSignalLiveActivities などのモジュラーサブスペックを使用してください。集約 pod 'OneSignalXCFramework'OneSignalComplete に解決され、位置情報が含まれます。クリーンな prebuild の後、ios/Podfile.lockOneSignalCompleteOneSignalLocation も表示されないことを確認してください。
onesignal-expo-plugin 2.6.0 以降では、プラグインの props に対する完全な TypeScript サポートと自動補完のために withOneSignal をインポートできます。
app.config.ts

3. SDKを初期化する

Expo構造(従来のアプリエントリまたはExpo Router)に応じて、これらのオプションに従ってOneSignalを初期化します。
App.tsxまたはApp.jsファイルで、提供されたメソッドを使用してOneSignalを初期化します。YOUR_APP_IDをOneSignalダッシュボード**設定 > キーとID**にあるOneSignalアプリIDに置き換えてください。
OneSignalアプリにアクセスできない場合は、チームメンバーに招待を依頼してください。
App.tsx
useCallback で再利用可能なリスナー リスナーが props や state にアクセスする必要がある場合は、useEffect の外で useCallback を使って定義し、追加と削除に同じ参照を使えるようにします。addEventListenerremoveEventListener に異なる関数参照を渡しても何も起こりません。リスナーは削除されず、コンポーネントがアンマウントされた後も発火する可能性があります。
追加の構成オプション、より複雑なセットアップ手順、または問題の報告については、OneSignal Expo Plugin GitHubリポジトリを確認してください。SDKはオープンソースであり、PRを歓迎します!

Androidセットアップ

Firebase認証情報を使用して、OneSignalアプリがAndroidプラットフォーム用に設定されていることを確認してください。 アプリのブランディングに合わせて通知アイコンをセットアップします。小さいアイコンは必須です。スキップすると、通知にはデフォルトのベルアイコンが表示されます。 Androidでビルド この時点で、物理Androidデバイスまたはエミュレーターでアプリをビルドして実行できるはずです。
Androidビルドが機能することを確認した後:

iOSセットアップ

p8トークン(推奨)またはp12証明書のいずれかを使用して、OneSignalアプリがiOSプラットフォーム用に構成されていることを確認してください。
これは、EAS構成で設定されたのと同じ認証情報を使用する必要があります。

iOSでビルドする

これで、実際のiOSデバイスまたはiOSシミュレーター(16.2+)でアプリをビルドして実行できるはずです。

iOSビルドの一般的なエラー

Xcode 15+でビルドする場合、クロスプラットフォームシステムに影響するデフォルト構成の変更により、このエラーが表示される場合があります。
  1. Xcodeで.xcworkspaceフォルダーを開き、アプリターゲット > Build Phasesに移動します。
  2. **「Embed Foundation Extensions」または「Embed App Extensions」**というフェーズが必要です。
  3. このビルドフェーズを**「Run Script」**の_上_にドラッグして移動します。
  4. アプリをビルドして実行します。エラーが解決されるはずです。

Xcodeのビルドフェーズの正しい順序。

「Copy only when installing」のチェックを外します。

RuntimeError - PBXGroupが不明なISA PBXFileSystemSynchronizedRootGroupの属性からオブジェクトを初期化しようとしました:{"isa"=>"...", "exceptions"=>["//", "..."], "explicitFileTypes"=>{}, "explicitFolders"=>[], "path"=>"OneSignalNotificationServiceExtension", "sourceTree"=>"<group>"}
修正:
  1. エラーの「path」の下にリストされているフォルダーを見つけます
  2. Xcodeプロジェクトサイドバーで、フォルダーを右クリックします
  3. **「Convert to Group」**を選択します

PBXGroupのパスエラー。


フォルダーをグループに変換します。

iOSビルドが動作することを確認した後、OneSignal SDK統合のテストを続行してください。

OneSignal SDK統合のテスト

このガイドでは、プッシュ通知、サブスクリプション登録、アプリ内メッセージをテストして、OneSignal SDK統合が正しく機能していることを確認する方法を説明します。

モバイルサブスクリプションを確認

1

テストデバイスでアプリを起動します。

初期化時にrequestPermissionメソッドを追加した場合、ネイティブのプッシュ許可プロンプトが自動的に表示されます。

iOSとAndroidのプッシュ許可プロンプト

2

OneSignalダッシュボードを確認

プロンプトを受け入れる前に、OneSignalダッシュボードを確認してください:
  • Audience > Subscriptionsに移動します。
  • ステータスが「Never Subscribed」の新しいエントリが表示されるはずです。

「Never Subscribed」ステータスのサブスクリプションを表示するダッシュボード

3

アプリに戻り、プロンプトで「許可」をタップします。

4

OneSignalダッシュボードのSubscriptionsページを更新します。

サブスクリプションのステータスがSubscribedと表示されるはずです。

「Subscribed」ステータスのサブスクリプションを表示するダッシュボード

モバイルサブスクリプションの作成に成功しました。 モバイルサブスクリプションは、ユーザーがデバイスで初めてアプリを開いたとき、またはユーザーが同じデバイスでアプリをアンインストールして再インストールしたときに作成されます。

テストサブスクリプションをセットアップ

テストサブスクリプションは、メッセージを送信する前にプッシュ通知をテストするのに役立ちます。
1

Test Usersに追加します。

ダッシュボードで、サブスクリプションの横にある**Options(3つのドット)**ボタンをクリックし、Add to Test Usersを選択します。

デバイスをtest usersに追加

2

サブスクリプションに名前を付けます。

test usersタブで後でデバイスを簡単に識別できるように、サブスクリプションに名前を付けます。
3

テストユーザーセグメントを作成します。

Audience > Segments > New Segmentに移動します。
4

セグメントに名前を付けます。

セグメントにTest Usersという名前を付けます(この名前は後で使用されるため重要です)。
5

Test Usersフィルターを追加し、Create Segmentをクリックします。

Test Usersフィルターを使用して「Test Users」セグメントを作成

テストユーザーのセグメントの作成に成功しました。 この個別のデバイスとテストユーザーのグループにメッセージを送信するテストが可能になりました。

API経由でテストプッシュを送信

1

App API KeyとApp IDを取得します。

OneSignalダッシュボードで、**Settings > Keys & IDs**に移動します。
2

提供されたコードを更新します。

以下のコードのYOUR_APP_API_KEYYOUR_APP_IDを実際のキーに置き換えます。このコードは、先ほど作成したTest Usersセグメントを使用します。
3

コードを実行します。

ターミナルでコードを実行します。
4

画像とconfirmed receiptを確認します。

すべてのセットアップ手順が正常に完了した場合、テストサブスクリプションは画像を含む通知を受信するはずです:

iOSとAndroidで画像付きプッシュ通知

画像は折りたたまれた通知ビューでは小さく表示されます。通知を展開すると、完全な画像が表示されます。
5

confirmed receiptを確認します。

ダッシュボードで、Delivery > Sent Messagesに移動し、メッセージをクリックして統計を表示します。confirmed統計が表示されるはずです。これは、デバイスがプッシュを受信したことを意味します。
API経由でセグメントに通知を送信することに成功しました。
  • 画像が受信されない場合は、Notification Service Extensionが不足している可能性があります。
  • confirmed receiptがない場合は、こちらのトラブルシューティングガイドを確認してください。
  • 問題が発生した場合は、APIリクエストとアプリ起動の最初から最後までのログを.txtファイルにコピー&ペーストしてください。その後、両方をsupport@onesignal.comと共有してください。

アプリ内メッセージを送信

アプリ内メッセージを使用すると、ユーザーがアプリを使用している間にユーザーとコミュニケーションできます。
1

デバイスでアプリを閉じるか、バックグラウンドにします。

これは、ユーザーが新しいセッションを開始する_前_にアプリ内オーディエンスの基準を満たす必要があるためです。OneSignalでは、ユーザーがアプリをバックグラウンドまたは閉じた状態から少なくとも30秒後に開くと、新しいセッションが開始されます。詳細については、アプリ内メッセージの表示方法に関するガイドを参照してください。
2

アプリ内メッセージを作成します。

  • OneSignalダッシュボードで、Messages > In-App > New In-Appに移動します。
  • Welcomeメッセージを見つけて選択します。
  • Audienceを、以前使用したTest Usersセグメントに設定します。

「Test Users」セグメントをアプリ内メッセージでターゲティング

3

必要に応じてメッセージコンテンツをカスタマイズします。

アプリ内Welcomeメッセージのカスタマイズ例

4

トリガーを「On app open」に設定します。

5

頻度をスケジュールします。

**Schedule > How often do you want to show this message?**で、Every time trigger conditions are satisfiedを選択します。

アプリ内メッセージのスケジュールオプション

6

メッセージをライブにします。

Make Message Liveをクリックして、Test Usersがアプリを開くたびにメッセージが利用できるようにします。
7

アプリを開いてメッセージを確認します。

アプリ内メッセージがライブになったら、アプリを開きます。次のように表示されるはずです:

デバイスに表示されたWelcomeアプリ内メッセージ

メッセージが表示されない場合:
  • 新しいセッションを開始します
    • 再度開く前に、少なくとも30秒間アプリを閉じるかバックグラウンドにする必要があります。これにより、新しいセッションが開始されます。
    • 詳細については、アプリ内メッセージの表示方法を参照してください。
  • まだTest Usersセグメントに含まれていますか?
    • アプリを再インストールしたりデバイスを切り替えたりした場合は、デバイスをTest Usersに再度追加し、Test Usersセグメントの一部であることを確認してください。
  • 問題が発生していますか?
    • 上記の手順を再現しながらデバッグログの取得に従ってください。これにより、support@onesignal.comと共有できる追加のログが生成され、何が起こっているかを調査するのに役立ちます。
OneSignal SDKのセットアップが成功し、次のような重要な概念を学びました:このガイドを続けて、アプリでユーザーを識別し、追加機能をセットアップします。

ユーザー識別

以前、モバイルサブスクリプションの作成方法を説明しました。次に、OneSignal SDKを使用して、すべてのサブスクリプション(プッシュ、メール、SMSを含む)にわたるユーザーの識別に拡張します。プラットフォーム間でユーザーを統合し、エンゲージメントするために、External ID、タグ、マルチチャネルサブスクリプション、プライバシー、イベントトラッキングについて説明します。

External IDを割り当て

External IDを使用して、バックエンドのユーザー識別子を使用して、デバイス、メールアドレス、電話番号間でユーザーを一貫して識別します。これにより、チャネルとサードパーティシステム間でメッセージングが統一されたままになります(特に統合に重要)。 アプリによって識別されるたびに、SDKのloginメソッドを使用してExternal IDを設定します。
OneSignalは、サブスクリプション(Subscription ID)とユーザー(OneSignal ID)に対して一意の読み取り専用IDを生成します。ユーザーが異なるデバイスでアプリをダウンロードしたり、ウェブサイトにサブスクライブしたり、アプリ外でメールアドレスや電話番号を提供したりすると、新しいサブスクリプションが作成されます。すべてのサブスクリプションにわたってユーザーを識別するために、SDK経由でExternal IDを設定することを強くお勧めします。作成方法に関係なく。

データタグを追加

タグは、ユーザープロパティ(usernamerole、設定など)とイベント(purchase_dategame_level、ユーザーインタラクションなど)を保存するために使用できる文字列データのキーと値のペアです。タグは、高度なメッセージパーソナライゼーションセグメンテーションを強化し、より高度なユースケースを可能にします。 アプリでイベントが発生したときに、SDKのaddTagおよびaddTagsメソッドを使用してタグを設定します。 この例では、ユーザーはレベル6に到達し、current_levelというタグで識別され、値は6に設定されます。

"current_level"というタグが"6"に設定されたOneSignalのユーザープロファイル

レベルが5から10の間のユーザーのセグメントを作成し、それを使用してターゲット化されたパーソナライズされたメッセージを送信できます:

current_level値が4より大きく10より小さいユーザーをターゲットとするセグメントを示すセグメントエディター


パーソナライズされたメッセージでLevel 5-10セグメントをターゲットとするプッシュ通知を示すスクリーンショット


パーソナライズされたコンテンツを含むプッシュ通知がiOSおよびAndroidデバイスで受信されます

メールおよび/またはSMSサブスクリプションを追加

以前、SDKがプッシュとアプリ内メッセージを送信するためにモバイルサブスクリプションを作成する方法を見ました。対応するサブスクリプションを作成することで、メールとSMSチャネルを通じてユーザーにリーチすることもできます。 メールアドレスや電話番号がOneSignalアプリに既に存在する場合、SDKはそれを既存のユーザーに追加し、重複は作成しません。 ダッシュボードのAudience > UsersまたはView user APIを使用して、統合されたユーザーを表示できます。

External IDによって統合されたプッシュ、メール、SMSサブスクリプションを持つユーザープロファイル

マルチチャネルコミュニケーションのベストプラクティス
  • メールまたはSMSサブスクリプションを追加する前に、明示的な同意を得てください。
  • 各コミュニケーションチャネルの利点をユーザーに説明してください。
  • ユーザーが好むチャネルを選択できるように、チャネルの設定を提供してください。

プライバシーとユーザー同意

OneSignalがユーザーデータを収集するタイミングを制御するには、SDKの同意ゲーティングメソッドを使用します: 詳細については、プライバシーとセキュリティのドキュメントを参照してください:

プッシュ許可のプロンプト

アプリを開いたときにすぐにrequestPermission()を呼び出すのではなく、より戦略的なアプローチを取ります。許可をリクエストする前に、アプリ内メッセージを使用してプッシュ通知の価値を説明します。 ベストプラクティスと実装の詳細については、プッシュ許可のプロンプトガイドを参照してください。

プッシュ、ユーザー、アプリ内イベントをリッスン

SDKリスナーを使用して、ユーザーのアクションと状態の変化に反応します。 SDKは、フックできるいくつかのイベントリスナーを提供します。詳細については、SDKリファレンスガイドを参照してください。

プッシュ通知イベント

完全なカスタマイズについては、Mobile Service Extensionsを参照してください。

ユーザー状態の変更

アプリ内メッセージイベント

  • addClickListener():アプリ内クリックアクションを処理します。ディープリンクやイベントの追跡に最適です。
  • addLifecycleListener():アプリ内メッセージの完全なライフサイクル(表示、クリック、閉じるなど)を追跡します。

高度なセットアップと機能

統合を強化するための追加機能を探索します:

Mobile SDKのセットアップとリファレンス

モバイルプッシュセットアップガイドを確認して、すべての主要機能が有効になっていることを確認してください。 利用可能なメソッドと設定オプションの詳細については、Mobile SDKリファレンスにアクセスしてください。
おめでとうございます!Mobile SDKセットアップガイドが正常に完了しました。


プライバシーとユーザー同意

アプリがデータ収集の前にユーザーの同意を必要とする場合(GDPRコンプライアンスなど)、同意が付与されるまでOneSignalのデータ収集を遅らせることができます。initialize前にsetConsentRequiredを呼び出します。
同意が必要でまだ付与されていない場合、SDKは初期化されますが、OneSignalにデータを送信しません。ユーザーがオプトインしたらsetConsentGiven(true)を呼び出してください。詳細については、個人データの取り扱いを参照してください。

トラブルシューティング

サポートが必要ですか?サポートチームとチャットするか、support@onesignal.comにメールしてください以下を含めてください:
  • 発生している問題の詳細と再現手順(利用可能な場合)
  • OneSignal App ID
  • 該当する場合は、External IDまたはSubscription ID
  • 該当する場合は、OneSignalダッシュボードでテストしたメッセージのURL
  • 関連するログまたはエラーメッセージ
お気軽にお問い合わせください!