# OneSignal: Japanese > OneSignal is a platform for sending push notifications, emails, in-app messages, and SMS campaigns via a single API, Journey Builder, and a dashboard. ## Japanese - [Japanese / ユーザーガイド (178 pages)](https://documentation.onesignal.com/_llms/ja/tab-61970413.md): Documentation for Japanese / ユーザーガイド. ### ホームページ - [OneSignalドキュメント](https://documentation.onesignal.com/docs/ja/home.md): OneSignalでより速く構築を開始します。クイックスタート、SDK、メッセージングチャネル、APIリファレンス、JourneysやLive Activitiesなどの高度な機能をご覧ください。 ### 開発者ガイド #### 開発者ドキュメント - [開発者](https://documentation.onesignal.com/docs/ja/developers.md): OneSignalのモバイルおよびWeb SDKをセットアップし、App IDとAPIキーを確認し、ユーザーを識別し、公開前に統合をテストします。 - [アイデンティティ検証](https://documentation.onesignal.com/docs/ja/identity-verification.md): サーバーで生成されたJWTを使用して外部ユーザーID、メール、SMSサブスクリプションを検証することで、ユーザーのなりすましを防止します。 ##### ユーザーモデル - [ユーザーモデルと移行ガイド](https://documentation.onesignal.com/docs/ja/user-model-migration-guide.md): OneSignalのデバイス中心モデルから、よりパーソナライズされたマルチチャネルエンゲージメントのための新しいユーザー中心APIとSDKに移行する方法を学びます。 - [モバイルSDKマッピング](https://documentation.onesignal.com/docs/ja/device-user-model-mobile-sdk-mapping.md): OneSignalのレガシーPlayer Model（v3およびv4）と最新のUser Model（v5+）のメソッドおよびプロパティ名を比較し、より簡単な移行のためにSwiftコード例を並べて表示します。 - [Web SDKマッピング](https://documentation.onesignal.com/docs/ja/device-user-model-web-sdk-mapping.md): レガシーPlayer Modelと新しいUser Model間でOneSignal Web SDKメソッドを比較します。TypeScriptベースのコード例と更新されたメソッドリファレンスで実装を移行する方法を学びます。 #### モバイルSDK ##### モバイルSDKセットアップ - [モバイルSDKセットアップ](https://documentation.onesignal.com/docs/ja/mobile-sdk-setup.md): Android、iOS、Huawei、React Native、Flutter、Unityなどのクロスプラットフォームフレームワーク向けにOneSignal SDKをセットアップする。 - [iOS SDKのセットアップ](https://documentation.onesignal.com/docs/ja/ios-sdk-setup.md): OneSignalを使用してiOSアプリにプッシュ通知とアプリ内メッセージを追加する方法。 - [Android SDKのセットアップ](https://documentation.onesignal.com/docs/ja/android-sdk-setup.md): Android StudioでOneSignal Android SDKを導入し、プッシュとアプリ内メッセージを追加。FCM認証情報、初期化、テスト送信を解説。 - [Unity SDKセットアップ](https://documentation.onesignal.com/docs/ja/unity-sdk-setup.md): OneSignal Unity SDKを使用してiOS、Android、Amazon、Huawei向けのUnityアプリにプッシュ通知を追加する方法。SDKのインストール、各プラットフォームの設定、初期化コードの追加からテスト送信までのセットアップ手順を解説します。 - [React Native SDKセットアップ](https://documentation.onesignal.com/docs/ja/react-native-sdk-setup.md): iOS、Android、AmazonアプリプラットフォームにOneSignal React Native SDKを統合するための包括的なガイド。前提条件、構成手順、プラットフォーム固有のセットアップ、および一般的な問題のトラブルシューティングを含みます。 - [Expo SDKセットアップ](https://documentation.onesignal.com/docs/ja/react-native-expo-sdk-setup.md): Expo SDK 53+とEAS Buildを使用して、OneSignal Expo SDKをiOSおよびAndroidアプリに統合し、プッシュ通知とアプリ内メッセージを実現します。 - [Flutter SDKセットアップ](https://documentation.onesignal.com/docs/ja/flutter-sdk-setup.md): iOSおよびAndroid用のFlutterアプリにOneSignal Flutter SDKを追加する手順 - [Flutterflow SDKセットアップ](https://documentation.onesignal.com/docs/ja/flutterflow-sdk-setup.md): iOSおよびAndroid用のFlutterflowアプリにOneSignal Flutter SDKを追加する手順 - [Cordova SDKのセットアップ](https://documentation.onesignal.com/docs/ja/cordova-sdk-setup.md): OneSignal Cordova SDKでiOS・Android向けのCordova、Ionic、Capacitorアプリにプッシュ通知とアプリ内メッセージを追加する手順。SDKのインストールから初期化、サービスワーカーの管理、テスト送信までの流れを解説します。 - [Capacitor SDKのセットアップ](https://documentation.onesignal.com/docs/ja/capacitor-sdk-setup.md): iOSおよびAndroid向けのCapacitorアプリにプッシュ通知を追加するためのOneSignal Capacitor SDKのセットアップ。 - [.NET MAUI SDKセットアップ](https://documentation.onesignal.com/docs/ja/net-sdk-setup.md): iOS、Android、デスクトップ向けのクロスプラットフォームMAUIアプリにOneSignal .NET SDKを追加する手順。 - [Amazon SDKセットアップ](https://documentation.onesignal.com/docs/ja/amazon-sdk-setup.md): プッシュ通知とアプリ内メッセージング機能のためにOneSignal SDKをAmazon Fire OSアプリに統合するためのステップバイステップガイド。 - [Huawei SDKセットアップ](https://documentation.onesignal.com/docs/ja/huawei-sdk-setup.md): Android Studio向けOneSignal Huawei SDKセットアップガイド ###### プラットフォーム資格情報セットアップ - [Android Firebase 認証情報](https://documentation.onesignal.com/docs/ja/android-firebase-credentials.md): OneSignalでFirebase Cloud Messaging（FCM）Service Account認証情報を構成し、Google Play StoreのアプリにAndroidプッシュ通知を有効にします。 - [iOS p8トークンベースのAPNs接続](https://documentation.onesignal.com/docs/ja/ios-p8-token-based-connection-to-apns.md): .p8認証キーを設定して、OneSignal経由でiOSまたはmacOSアプリをApple Push Notification service（APNs）に接続します。 - [iOS p12証明書の生成](https://documentation.onesignal.com/docs/ja/ios-p12-generate-certificates.md): .p12プッシュ証明書を生成してアップロードし、OneSignalを通じてiOSまたはmacOSアプリをApple Push Notification service（APNs）に接続します。 - [Amazon APIキーの生成](https://documentation.onesignal.com/docs/ja/generate-an-amazon-api-key.md): ステップバイステップガイド - [Huawei認証](https://documentation.onesignal.com/docs/ja/authorize-onesignal-to-send-huawei-push.md): PushKitのセットアップ、APIキーの設定、中国のユーザー向けアプリ用のHuaweiのオプションのメッセージ自己分類を含む、プッシュ通知用にHuaweiアプリをOneSignalに接続するステップバイステップガイド。 ##### モバイル SDK リファレンス - [モバイルSDKリファレンス](https://documentation.onesignal.com/docs/ja/mobile-sdk-reference.md): OneSignal Mobile SDKの包括的なAPIリファレンス。初期化、ユーザーID、サブスクリプション、タグ、権限、アプリ内メッセージ、Live Activitiesなどを含みます。Android、iOS、Unity、React Native、Flutter、Cordova/Ionicプラットフォームをサポートします。 - [モバイルサービスエクステンション](https://documentation.onesignal.com/docs/ja/service-extensions.md): iOSのNotification Service ExtensionとAndroidのサービスエクステンションで、表示前にプッシュ通知をインターセプトしてカスタマイズする方法。リッチメディア、受信確認、カスタムスタイル、バックグラウンドデータ処理を実現します。 - [通知トレイの管理](https://documentation.onesignal.com/docs/ja/managing-the-notification-tray.md): Android および iOS の通知トレイにおける OneSignal モバイルプッシュ通知の動作：クリックと却下の処理、復元された通知、バッジ、プログラムによる通知のクリア、サービス拡張機能。 - [OSNotification ペイロード](https://documentation.onesignal.com/docs/ja/osnotification-payload.md): OneSignalのOSNotificationオブジェクトのリファレンス。すべてのペイロードフィールド、AndroidおよびiOS固有のプロパティ、カスタムデータ、クリックアクションを含みます。 - [iOS: App Clipのサポート](https://documentation.onesignal.com/docs/ja/app-clip-support.md): iOS App ClipでOneSignalプッシュ通知を有効化および設定する方法を学びます。セットアップ手順、制限事項、Target-Content-IDなどの高度なエクスペリエンスのサポートについて説明します。 ##### モバイル SDK トラブルシューティング - [モバイルSDKトラブルシューティング](https://documentation.onesignal.com/docs/ja/mobile-troubleshooting.md): OneSignal Mobile SDKの一般的な問題を解決します。iOS、Android、クロスプラットフォームフレームワーク全体でのプッシュ配信の失敗、APNSエラー、アプリ内メッセージングの問題が含まれます。 - [デバッグログの取得](https://documentation.onesignal.com/docs/ja/capturing-a-debug-log.md): OneSignal SDKを使用してモバイルアプリから詳細なデバッグログをキャプチャする方法を学びます。このガイドでは、詳細ログの有効化、問題の再現、AndroidおよびiOSプラットフォーム全体でプッシュ通知の問題をトラブルシューティングするためのログの共有について説明します。 #### ウェブSDK - [Web SDKリファレンス](https://documentation.onesignal.com/docs/ja/web-sdk-reference.md): OneSignal Web SDK v16の完全なAPIリファレンス。init初期化とデバッグ、ログインによるユーザー識別、タグなどのユーザープロパティ、プッシュサブスクリプション管理、スライドダウンプロンプト、イベントリスナーの各メソッドと使用例を網羅します。 ##### ウェブSDKセットアップ - [Web SDKセットアップ](https://documentation.onesignal.com/docs/ja/web-sdk-setup.md): JavaScript SDKの導入、サービスワーカーのアップロード、ダッシュボード設定を通じてWebサイトにOneSignal Webプッシュ通知を追加する手順。Chrome、Firefox、Edge、Safariに対応し、initオプションやテスト方法も解説します。 - [iOS Webプッシュセットアップ](https://documentation.onesignal.com/docs/ja/web-push-for-ios.md): Safari、Chrome、Edgeブラウザーのマニフェストファイルのセットアップ、ユーザーオンボーディング戦略、実装のベストプラクティスを含む、iOSおよびiPadOSデバイスでWebプッシュ通知を有効にするための完全なガイド。 - [OneSignal service worker](https://documentation.onesignal.com/docs/ja/onesignal-service-worker.md): OneSignalSDKWorker.js ファイルをセットアップおよび設定して、ウェブサイトが OneSignal 経由でウェブプッシュ通知を受信・表示できるようにします。 - [カスタムコードによるWebプッシュ設定](https://documentation.onesignal.com/docs/ja/web-push-custom-code-setup.md): カスタムコードを使用してOneSignal Webプッシュ通知をセットアップする上級者向けガイド。JavaScript SDKの追加、サービスワーカーの構成、サイトでの初期化コードの記述など、プログラムによる高度な制御が必要な場合のセットアップ手順を解説します。 - [Google Tag Manager セットアップ](https://documentation.onesignal.com/docs/ja/google-tag-manager.md): Google Tag Manager（GTM）を使用してウェブサイトに OneSignal Web Push を追加する方法。Service Worker のセットアップ、初期化、タグの安全な設定を含みます。 - [Angular Web SDKセットアップ](https://documentation.onesignal.com/docs/ja/angular-setup.md): onesignal-ngxパッケージを使用して、OneSignal Webプッシュ通知をAngularアプリケーションに統合します。シームレスなプッシュ通知を配信するためのインストール、設定、サービスワーカーのトラブルシューティング方法を学びます。 - [ReactJSとNextJSのセットアップ](https://documentation.onesignal.com/docs/ja/react-js-setup.md): ReactJSまたはNextJS Webアプリケーションにプッシュ通知を統合する方法を学びます。初期化、サービスワーカーのセットアップ、TypeScriptサポートを含みます。 - [Vue JS Web SDKセットアップ](https://documentation.onesignal.com/docs/ja/vue-js-setup.md): onesignal-vueまたは@onesignal/onesignal-vue3プラグインを使用してVue.jsアプリケーションにOneSignal Webプッシュ通知を統合します。シームレスなプッシュ配信のためのインストール、構成、サービスワーカーのカスタマイズ方法を学びます。 ##### ウェブSDKトラブルシューティング - [Web SDKのトラブルシューティング](https://documentation.onesignal.com/docs/ja/troubleshooting-web-push.md): サービスワーカーエラー、オリジンの不一致、MIMEタイプ、通知が表示されない問題など、OneSignal Web Pushの問題をトラブルシューティングします。 - [キャッシュのクリアとプッシュ権限のリセット](https://documentation.onesignal.com/docs/ja/clearing-cache-and-resetting-push-permissions.md): Chrome、Firefox、Safariでブラウザのプッシュ権限、Service Worker、サイトデータをリセットして、クリーンなテスト環境を確保し、Webプッシュ通知の問題を解決する方法を学びます。 - [WebプッシュWebhook](https://documentation.onesignal.com/docs/ja/webhooks.md): ユーザーがWebプッシュ通知を表示、クリック、または却下したときにリアルタイム通知を受信するためのHTTP Webhookをセットアップ。Chrome、Firefox、Safariブラウザーサポートの例を含む完全ガイド。 #### ライブアクティビティ - [Live Activities開発者セットアップ](https://documentation.onesignal.com/docs/ja/live-activities-developer-setup.md): OneSignalを使用してiOSアプリでLive Activitiesを設定して、ロック画面とDynamic Islandにリアルタイム更新を表示します。 - [クロスプラットフォームLive Activity SDKセットアップ](https://documentation.onesignal.com/docs/ja/cross-platform-live-activity-setup.md): React Native、Flutter、Unity、Cordova、Capacitor、.NET MAUIアプリにiOS Live Activitiesを追加。setupDefaultによりSDKがActivityKitを管理し、書くネイティブコードはウィジェットレイアウトのみです。 - [Android Live Update通知](https://documentation.onesignal.com/docs/ja/android-live-notifications.md): OneSignalプッシュを基盤にAndroid Live Updatesを構築します。Notification Service Extension経由で構造化ペイロードを渡し、単一の常設通知をその場で更新してiOS Live Activitiesを再現します。 #### デスクトップ & ウォッチセットアップ - [macOSアプリセットアップ](https://documentation.onesignal.com/docs/ja/macos-app-setup.md): Mac CatalystまたはダイレクトAPIアクセスを使用して、OneSignalをmacOSアプリに統合する方法を学びます。プラットフォームの設定、SDKのインストール、プッシュ通知の送信のステップバイステップガイダンス。 - [Windowsアプリセットアップ](https://documentation.onesignal.com/docs/ja/windows-app-setup.md): Windows Push Notification Service（WNS）とOneSignalのREST APIを使用して、Universal Windows Platform（UWP）アプリにOneSignalプッシュ通知を統合するための完全ガイド - [watchOSとWear OSサポート](https://documentation.onesignal.com/docs/ja/watchos-and-wear-os-support.md): スタンドアロンApple watchOSおよびAndroid Wear OSアプリケーションにOneSignalプッシュ通知を実装するための完全なガイド。セットアップ手順とAPI統合を含みます。 ### チュートリアル #### チュートリアル - [チュートリアルとユースケース](https://documentation.onesignal.com/docs/ja/tutorials.md): OneSignal機能を実装し、エンゲージメント、リテンション、収益を向上させるためのステップバイステップのチュートリアルとベストプラクティスの例を探索します。 #### 🏢 業界別 - [ゲーム戦略](https://documentation.onesignal.com/docs/ja/gaming-industry.md): ゲーム業界向けメッセージング実装ハブ。プレイヤーの識別、ライフサイクルタグ、行動カスタムイベント、セグメント設計に加え、プレイヤーのオンボーディングや再エンゲージメントなど、モバイルゲームやライブサービスゲームに役立つ実践的なJourneyプレイブックを紹介します。 - [金融・フィンテック戦略](https://documentation.onesignal.com/docs/ja/financial-fintech-industry.md): 金融・フィンテック業界向けメッセージング実装ハブ。ユーザー識別、KYC・セキュリティタグ、取引カスタムイベント、セグメント設計に加え、新規ユーザー検証やコンプライアンス手順の完了促進、クロスセル、リテンションに役立つ実践的なJourneyプレイブックを紹介します。 - [ニュース・メディア戦略](https://documentation.onesignal.com/docs/ja/news-and-media-industry.md): ニュース・メディア業界向けメッセージング実装ハブ。ユーザー識別、カテゴリ関心タグ、閲覧行動カスタムイベント、セグメント設計に加え、読者の拡大、ペイウォール転換、離脱した読者の再エンゲージメントに役立つJourneyプレイブックとプロンプトのベストプラクティスを紹介します。 #### 📈 エンゲージメント & リテンション - [カート放棄チュートリアル](https://documentation.onesignal.com/docs/ja/abandoned-cart.md): OneSignalを使用してカート放棄通知で失われた売上を回復しましょう。カートアクティビティの追跡、適切なセグメントの構築、Journeysによるタイムリーなリマインダー送信方法を学びます。 - [アクティビティフィードの作成](https://documentation.onesignal.com/docs/ja/create-an-activity-feed.md): OneSignalのREST API、Event Streams、またはデバイス上のロジックを使用して、ユーザー通知履歴を追跡および表示するアプリ内アクティビティフィードを構築する方法を学びます。 - [予約確認](https://documentation.onesignal.com/docs/ja/booking-confirmations.md): カスタムイベント、Journeys、Data Feedsを使い、予約完了後の確認メールと未完了時の放棄予約回復メールを自動送信するチュートリアル。booking_startedとbooking_completeイベントで分岐するJourneyの構築手順を解説します。 - [ボタン駆動のオンボーディングカルーセルを構築する](https://documentation.onesignal.com/docs/ja/in-app-onboarding-carousel-tutorial.md): ボタンナビゲーションと自動終了機能を備えたHTML アプリ内メッセージを使用して、マルチステップのオンボーディングフローを作成します。 - [ソーシャルアクティビティ](https://documentation.onesignal.com/docs/ja/social-activity.md): いいね、返信、フォロー、ダイレクトメッセージ、ゲーム内イベントなどのソーシャルアクションが発生したときに、プッシュ・メール・SMS通知を送信する方法。custom_dataを使ったパーソナライズされたアラートで、非アクティブなユーザーの再エンゲージメントを促進します。 - [古いアプリバージョンをターゲットにしてアプリの更新を促す](https://documentation.onesignal.com/docs/ja/app-version-update.md): アプリ内メッセージを使用して古いアプリバージョンを検出し、ユーザーに更新を促す方法。iOS と Android のプラットフォーム別セグメントと設定手順を解説します。 - [より多くのアプリストアレビューを獲得する](https://documentation.onesignal.com/docs/ja/example-app-store-review.md): OneSignalのアプリ内メッセージを使用してユーザーにApp StoreまたはGoogle Playのレビューを促し、ネイティブのiOSおよびAndroidレビュープロンプトで摩擦を減らし、評価を向上させます。 - [バナーアプリ内メッセージでユーザーをオンボーディング](https://documentation.onesignal.com/docs/ja/example-create-a-tutorial.md): アプリUIをブロックしないコンテキストに応じたトップとボトムのバナーアプリ内メッセージでユーザーをガイドします。 #### 🔔 重要または時限性のあるメッセージを配信 - [トランザクションメッセージ](https://documentation.onesignal.com/docs/ja/transactional-messages.md): OneSignalのAPIを使用して、プッシュ、メール、またはSMS経由でパーソナライズされたデータを使用したOTP、請求更新、リマインダーなどのトランザクションメッセージを送信する方法を学びます。 - [フォールバックメッセージ：チャネル間で確実に配信する](https://documentation.onesignal.com/docs/ja/push-fallback-method.md): OneSignalでフォールバック戦略を実装して、プッシュ通知が失敗した場合でもメールまたはSMS経由で重要なメッセージが確実に配信されるようにします。Journeys、API、セグメンテーションを使用したクロスチャネルメッセージングの設定方法を学び、信頼性の高いユーザーエンゲージメントを実現します。 - [位置情報ベースのメッセージ](https://documentation.onesignal.com/docs/ja/location-triggered-event.md): OneSignalを使用して、国、GPS座標、またはジオフェンスでユーザーをセグメント化し、位置情報トリガーのプッシュ通知を送信します。 #### 🧠 ターゲティング & 個人化を強化 - [トピックへの関心を追跡してターゲティングを強化](https://documentation.onesignal.com/docs/ja/auto-segment-users-by-page-visit.md): ユーザーが訪問したページやプッシュ通知を購読したページに基づいてOneSignalでユーザーにタグ付けし、トピック別セグメントを作成する方法。ページ訪問ごとのカウンタータグと購読ソース記録の2つのパターンを使い分けて、Webやアプリのターゲットキャンペーンを強化します。 - [アプリ内メッセージで位置情報権限をリクエストする](https://documentation.onesignal.com/docs/ja/location-opt-in-prompt.md): ネイティブのAndroidまたはiOS位置情報権限リクエストをトリガーする前に、OneSignalのソフトプレプロンプトを使用してモバイルアプリで位置情報追跡を有効にするようユーザーを案内します。 - [フィードバックを求めるアンケートを作成する](https://documentation.onesignal.com/docs/ja/example-create-a-survey.md): カルーセル、ボタンクリックアクション、結果、およびタグを使用して、分析とセグメンテーションのための複数ページのアプリ内アンケートを構築します。 - [特定のAndroidメーカーとデバイスをターゲットにする](https://documentation.onesignal.com/docs/ja/example-target-certain-android-manufacturers-and-devices.md): アプリがスワイプされたときにプッシュ通知をブロックすることで知られているメーカーのAndroidデバイスを特定してターゲットにし、アプリ内メッセージを使用して適切な設定を有効にする方法をユーザーに教育します。 #### 🛠️ ユーザーエクスペリエンスとオンボーディングの改善 - [メール用の確認済みオプトインを設定する](https://documentation.onesignal.com/docs/ja/double-opt-in-email.md): タグ、セグメント、Journeyを使用してOneSignalでダブルオプトイン（確認済みオプトイン）プロセスを実装し、エンゲージメント、コンプライアンス、リスト品質を向上させる方法を学びます。 - [プリファレンスセンター](https://documentation.onesignal.com/docs/ja/preference-center.md): OneSignal APIを使用して、通知トピック、頻度、チャネル、データプライバシー設定を管理するカスタムユーザープリファレンスセンターをアプリまたはウェブサイトに実装する方法を学びます。 - [検証、マジックリンク、OTP、およびダブルオプトインメッセージを送信する](https://documentation.onesignal.com/docs/ja/example-verification-magic-link-otp.md): ワンタイムパスワード、マジックリンク、ダブルオプトインフローを含む、OneSignalを使用したメールおよびSMS検証メッセージの例とテンプレートおよびAPI例。 - [iOS：画像カルーセルプッシュ通知](https://documentation.onesignal.com/docs/ja/ios-image-carousel-push-notifications.md): Swiftを使用してOneSignal iOSプッシュ通知に画像カルーセルを実装する方法。 ### API Reference #### Using the REST APIs - [REST API overview](https://documentation.onesignal.com/reference/rest-api-overview.md): Programmatic access to OneSignal messaging, user management, segments, Journeys, and data exports over HTTPS with rate limiting and retry support. - [Rate limits and error handling](https://documentation.onesignal.com/reference/rate-limits.md): Understand OneSignal API and application rate limits, common errors, retry behavior, and how to safely recover from failures without sending duplicate messages or disabling your app. #### API reference ##### Messages - [Sending messages with the OneSignal API](https://documentation.onesignal.com/reference/create-message.md): Send push notifications, emails, SMS, and Live Activities with the OneSignal API. Covers audience targeting, message composition, scheduling, and response handling. - [Idempotent API requests](https://documentation.onesignal.com/reference/idempotent-notification-requests.md): Prevent duplicate messages or custom events when retrying API requests. - [Push notification](https://documentation.onesignal.com/reference/push-notification.md): Send a message using the push notification channel. - [Email](https://documentation.onesignal.com/reference/email.md): Send a message using the email channel. - [SMS](https://documentation.onesignal.com/reference/sms.md): Send a message using the SMS channel. - [View message](https://documentation.onesignal.com/reference/view-message.md): View the details of a single message and the Outcomes associated with it. - [View messages](https://documentation.onesignal.com/reference/view-messages.md): View the details for a collection of messages. - [Cancel message](https://documentation.onesignal.com/reference/cancel-message.md): Stop a scheduled or currently outgoing message. - [Message history](https://documentation.onesignal.com/reference/message-history.md): View which subscriptions received a particular message - [Estimated recipients](https://documentation.onesignal.com/reference/count-unsaved.md): Returns the estimated number of recipients for a notification's targeting, without creating or sending anything. ##### Live Activities - [Start Live Activity](https://documentation.onesignal.com/reference/start-live-activity.md): Remotely start an iOS Live Activity with the OneSignal REST API, also known as push-to-start. Covers required body fields, choosing an activity_id, and audience targeting. - [Update Live Activity](https://documentation.onesignal.com/reference/update-live-activity-api.md): Update the content of a running iOS Live Activity or end it with the OneSignal REST API. Covers required body fields, update priority, and dismissal timing. ##### Custom Events - [Create custom events](https://documentation.onesignal.com/reference/create-custom-events.md): The Custom Events API allows you to record user events. Custom events can represent any action users take in your application, such as completing a purchase, viewing content, or achieving milestones. ##### Users - [Create user](https://documentation.onesignal.com/reference/create-user.md): Create a new user or modify the subscriptions associated with an existing User. - [View user](https://documentation.onesignal.com/reference/view-user.md): Retrieve a user including aliases, properties, and subscriptions. - [Update user](https://documentation.onesignal.com/reference/update-user.md): Modify a user's properties. - [Delete user](https://documentation.onesignal.com/reference/delete-user.md): Delete a user including all associated properties, subscriptions, and identity. - [View user identity](https://documentation.onesignal.com/reference/fetch-aliases.md): Retrieve all aliases associated with a user using a known alias, such as an `external_id`, `onesignal_id`, or a custom alias. This API helps you map back to a user's full identity from any one piece of identifying information. - [View user identity (by subscription)](https://documentation.onesignal.com/reference/fetch-identity-by-subscription.md): Retrieve all aliases linked to a user using a known `subscription_id`. This is useful when the user's identity is unknown but you have access to one of their push, email, or SMS subscriptions. - [Create or update alias](https://documentation.onesignal.com/reference/create-alias.md): Add or update aliases on an existing user when you already know one of that user's aliases, such as an external_id, onesignal_id, or custom alias. Updates the identity object only. - [Create alias (by subscription)](https://documentation.onesignal.com/reference/create-alias-by-subscription.md): Create or update an alias for a user using a known subscription ID. - [Delete alias](https://documentation.onesignal.com/reference/delete-alias.md): Remove a specific alias from a user. ##### Subscriptions - [Create Subscription by alias](https://documentation.onesignal.com/reference/create-subscription.md): Attach a new subscription (email, SMS, or push) to an existing OneSignal user identified by an alias. - [Update Subscription by ID](https://documentation.onesignal.com/reference/update-subscription.md): Update properties on an existing OneSignal subscription using its subscription_id. Commonly used to enable or disable a subscription when managing outside of the OneSignal SDK. - [Update Subscription by token](https://documentation.onesignal.com/reference/update-subscription-by-token.md): Update properties on an existing Subscription using its token. Commonly used to enable or disable subscription status when managing outside of the OneSignal SDK. - [Delete Subscription](https://documentation.onesignal.com/reference/delete-subscription.md): Delete a specific subscription by its subscription_id. This stops messages from being sent to that subscription but does not prevent future subscriptions with the same token. - [Transfer Subscription](https://documentation.onesignal.com/reference/transfer-subscription.md): Transfer a Subscription to a different user within the same OneSignal app. Useful for associating existing Subscriptions like push, email, or SMS with a new or updated user identity. - [Unsubscribe email with token](https://documentation.onesignal.com/reference/unsubscribe-with-token.md): Unsubscribe an email address from future messages by calling this API from your custom unsubscribe page. Automatically disables the associated email subscription using a token-based approach. ##### Templates - [Create template](https://documentation.onesignal.com/reference/create-template.md): Create reusable message templates for push, email, and SMS channels. Templates can be accessed through both the dashboard and API using a `template_id`. - [Update template](https://documentation.onesignal.com/reference/update-template.md): Update existing OneSignal message templates for push, email, or SMS. Changes apply immediately across dashboard and API usage via the `template_id` reference. - [View templates](https://documentation.onesignal.com/reference/view-templates.md): Retrieve a paginated list of message templates from your OneSignal app. This endpoint returns summary information for each template, including ID, name, creation, and update timestamps. - [View template](https://documentation.onesignal.com/reference/view-template.md): Retrieve the details of a specific message template in your OneSignal app using its template ID. This API returns the template content, target channel, and timestamps for creation and last update. - [Delete template](https://documentation.onesignal.com/reference/delete-template.md): Permanently delete a specific message template from your OneSignal app using its template ID. Templates used in Journeys must be removed from those Journeys before deletion. - [Copy template to another app](https://documentation.onesignal.com/reference/copy-template-to-another-app.md): Create a duplicate of a template in another app. The new template will be completely separate from the original (including having a new template_id) but will be created with all the same content. ##### Segments - [View segments](https://documentation.onesignal.com/reference/view-segments.md): Retrieve a list of segments associated with a specific OneSignal app. Useful for programmatically accessing segment metadata such as name, creation date, and status. - [View segment](https://documentation.onesignal.com/reference/view-segment.md): Retrieve details for a single segment by its ID, including subscriber count and optionally segment metadata and filters. - [Create segment](https://documentation.onesignal.com/reference/create-segments.md): Programmatically create segments in your OneSignal app using flexible filters and targeting rules. - [Update segment](https://documentation.onesignal.com/reference/update-segment.md): Update an existing segment's name and/or filters. The name parameter is always required. When filters are provided, all existing filters are replaced with the new ones. - [Delete segment](https://documentation.onesignal.com/reference/delete-segments.md): Delete segments from OneSignal. Does not delete users or subscriptions. ##### Journeys - [View journeys](https://documentation.onesignal.com/reference/view-journeys.md): Retrieve a paginated list of journeys for an app, with cursor-based pagination and a lightweight summary representation of each journey. - [View journey](https://documentation.onesignal.com/reference/view-journey.md): Retrieve the full configuration of a single journey by its UUID, including its audience, schedule, and node graph. - [View journey stats](https://documentation.onesignal.com/reference/view-journey-stats.md): Retrieve performance stats for a single journey, including journey-level counts, per-node counts, per-branch counts, and channel delivery stats. - [Create journey](https://documentation.onesignal.com/reference/create-journey.md): Create a new journey with an audience and a node graph. Journeys are always created in the draft state. - [Duplicate journey](https://documentation.onesignal.com/reference/duplicate-journey.md): Copy an existing journey into a new draft. You can apply overrides to the copy in the same request. - [Update journey](https://documentation.onesignal.com/reference/update-journey.md): Apply a partial update to a journey with JSON Merge Patch, and activate a draft journey by transitioning its state. - [Update journey node](https://documentation.onesignal.com/reference/update-journey-node.md): Apply a partial update to a single journey node, located by its server-assigned id, with JSON Merge Patch. - [Delete journey](https://documentation.onesignal.com/reference/delete-journey.md): Permanently delete a journey by its UUID. Deletion cannot be undone; archive a running journey instead if you need to keep its data. ##### Configuration - [View apps](https://documentation.onesignal.com/reference/view-apps.md): Retrieve a list of all OneSignal apps associated with your account, including key app details like name, App ID, subscription counts, and timestamps. Useful for managing multiple apps through the OneSignal API. - [View an app](https://documentation.onesignal.com/reference/view-an-app.md): View the details of a single OneSignal app - [Create an app](https://documentation.onesignal.com/reference/create-an-app.md): Programmatically create a new OneSignal app via the REST API. This guide explains required fields, supported platform configurations (Web, Android, iOS), and how to properly authenticate using your Organization API key. - [Update an app](https://documentation.onesignal.com/reference/update-an-app.md): Use to update the name or push platform configuration of an existing app. This guide explains required parameters and platform-specific update rules - [View API keys](https://documentation.onesignal.com/reference/view-api-keys.md): View the details of all of your current app API keys (Rich Authentication Token) for a single OneSignal app. - [Create API key](https://documentation.onesignal.com/reference/create-api-key.md): Use the OneSignal API to create a new Rich Authentication Token (App API Key) for a specific app. This guide explains how to authenticate with the Organization API key and configure optional IP allowlists using CIDR notation. - [Delete API key](https://documentation.onesignal.com/reference/delete-api-key.md): Delete a specific Rich Authentication Token (App API Key) for a OneSignal app. Requires your Organization API Key and the token's unique ID, not the token value itself. - [Update API key](https://documentation.onesignal.com/reference/update-api-key.md): Update a Rich Authentication Token (App API Key) for a OneSignal app. Modify the token's name or IP allowlist settings using your Organization API Key. - [Rotate API key](https://documentation.onesignal.com/reference/rotate-api-key.md): Rotate an existing App API Key (Rich Authentication Token) for a OneSignal app. Useful when a token is compromised or needs replacement without creating a new key from scratch. ##### Analytics - [Export subscriptions CSV](https://documentation.onesignal.com/reference/csv-export.md): Generate a GZip-compressed CSV export of your current subscription data using this API endpoint. - [Export audience activity CSV](https://documentation.onesignal.com/reference/export-csv-of-events.md): Export a compressed CSV report of audience-level delivery and engagement data for a specific message. This includes sent, delivered, clicked, failed, and unsubscribed events across Push, Email, and SMS channels. - [View outcomes](https://documentation.onesignal.com/reference/view-outcomes.md): View and export push notification outcome metrics such as clicks, conversions, and custom events. ##### Deprecated - [View players](https://documentation.onesignal.com/reference/view-devices.md): GET `https://onesignal.com/api/v1/players?app_id={app_id}&limit={limit}&offset={offset}` - [View player](https://documentation.onesignal.com/reference/view-device.md): GET https://onesignal.com/api/v1/players/{player_id} - [Add a player](https://documentation.onesignal.com/reference/add-a-device.md): POST `https://onesignal.com/api/v1/players` - [Edit player](https://documentation.onesignal.com/reference/edit-device.md): put https://onesignal.com/api/v1/players/{player_id} - [Edit tags with external user id](https://documentation.onesignal.com/reference/edit-tags-with-external-user-id.md): put https://onesignal.com/api/v1/apps/{app_id}/users/{external_user_id} - [Delete player record](https://documentation.onesignal.com/reference/delete-user-record.md): delete https://onesignal.com/api/v1/players/{player_id}?app_id={app_id} #### SDKs - [Server SDK reference](https://documentation.onesignal.com/docs/en/server-sdk-reference.md): Install, configure, and use OneSignal server SDKs to send push notifications, emails, and SMS from your backend in Node.js, Python, Java, Go, PHP, Ruby, C#, and Rust. ### Release Notes #### Release Notes - [Changelog](https://documentation.onesignal.com/release-notes/changelog.md): Follow the OneSignal changelog for new features, product updates, and bug fixes across push, email, SMS, in-app messages, Journeys, and analytics. - [SDK Releases](https://documentation.onesignal.com/release-notes/sdk-releases.md): View the latest OneSignal SDK releases and updates. ## OpenAPI Specs - [openapi](/openapi.json) ## Optional - [Blog](https://onesignal.com/blog) - [GitHub](https://github.com/OneSignal) - [YouTube](https://www.youtube.com/@onesignalofficial/playlists)