- はじめに — OneSignal Appにアクセスし、APIキーを取得する
- メッセージングチャネルの設定 — SDKをインストールし、チャネルを設定する
- SDKとAPIリファレンス — メソッド、クラス、エンドポイントの詳細ドキュメント
- ユーザーとアイデンティティ — ユーザーを識別し、サブスクリプションを管理し、アクセスを保護する
- テストとデバッグ — 本番稼動前に統合を確認する
- WebhooksとEvents — サーバー側でメッセージイベントを受信する
はじめに
チームがすでにOneSignalアカウントを持っている場合は、管理者に招待を依頼してOrganizationに参加してください。それ以外の場合は、アカウントを作成して開始してください。 OneSignal Appは、ユーザーとメッセージデータが保存される場所です。各AppにはApp ID、APIキー、メッセージングチャネルがあります。異なるプロジェクトや環境に対応するために、1つのOrganizationに複数のAppを持つことができます。Apps、Organizations、アカウント
Apps、Organizations、アカウントの相互関係。
キーとID
認証用のApp ID、REST APIキー、Organization IDを確認します。
チームメンバーを追加
開発者を招待し、Organizationでロールを割り当てます。
使用量と請求
請求、請求書、使用量の詳細。
メッセージングチャネルの設定
OneSignal SDKをインストールして、プラットフォーム全体のユーザーエンゲージメントを作成・追跡します。各メッセージチャネルには、認証情報、SDK初期化、チュートリアルをカバーする独自のセットアップガイドがあります。モバイルSDKセットアップ
iOS、Android、Huawei、AmazonのSDKセットアップ。プッシュ通知、アプリ内メッセージ、Live Activitiesが有効になります。
Webプッシュ
Web SDKインストールとブラウザプッシュ通知のセットアップ。
メール
メールチャネルの設定と送信元ドメインの確認。
アプリ内メッセージ
モバイルアプリ内にリッチでインタラクティブなメッセージを表示します。
SMS
SMSチャネルのセットアップとキャリア登録。
RCS
ブランドコンテンツと既読確認を備えたリッチメッセージ。
Live Activities
iOSの動的ロック画面更新。Androidでも同様の機能が利用可能。
モバイルプッシュプロンプト
モバイルでプッシュサブスクリプションを収集するオプトインプロンプトを設定します。
Webプッシュプロンプト
Webでプッシュサブスクリプションを収集するオプトインプロンプトを設定します。
SDKとAPIリファレンス
クライアントSDK、サーバーSDK、REST APIの詳細ドキュメント。モバイルSDKリファレンス
iOS、Android、クロスプラットフォームSDKのメソッド、クラス、イベントフック。
Web SDKリファレンス
初期化、ユーザー管理、サブスクリプションメソッド、カスタムトリガー。
サーバーSDKリファレンス
Node.js、Python、Java、Go、PHP、Ruby、C#、Rust用のサーバーSDKのインストールと設定。
REST API概要
エンドポイント、認証、レート制限、リクエスト/レスポンス形式。
トランザクションメッセージ
パーソナライズされたデータでOTP、レシート、時間に敏感なアラートをAPIで送信します。
GitHubのサーバーSDK
すべてのサーバーSDKライブラリのソースコードと例。
ユーザーとアイデンティティ
OneSignalは各人にOneSignal IDを割り当て、デバイス、メールアドレス、電話番号をサブスクリプションとして追跡します。ユーザーは匿名のまま、External IDを使用してloginを呼び出すことで識別されます。ユーザーを識別すると、チャネルとデバイス全体のサブスクリプションが統合されます。
ユーザー
ユーザーモデル、External ID、匿名ユーザーと識別済みユーザー、ログイン/ログアウト。
サブスクリプション
メッセージを受信するデバイス、メールアドレス、電話番号。
本人確認
ユーザーなりすましを防ぐためにサーバー生成JWTを要求します。
エイリアス
クロスプラットフォーム追跡と統合のためにカスタム識別子をユーザーにマッピングします。
タグ
パーソナライゼーションとセグメンテーションのためにユーザーにキー値データを設定します。
カスタムイベント
Journeysをトリガーするか分析を支援するためにユーザーアクションを追跡します。
テストとデバッグ
全オーディエンスへの送信前に、統合が機能していることを確認します。テストサブスクリプション
プッシュ、メール、SMS用のテストサブスクリプションを見つけて設定します。
デバッグログ
トラブルシューティングのためにモバイルアプリから詳細なSDKログをキャプチャします。
モバイルトラブルシューティング
一般的なプッシュ配信、APNS、アプリ内メッセージングの問題を解決します。
Webトラブルシューティング
Service Worker、ブラウザ互換性、Webプッシュの問題を修正します。
WebhooksとEvents
分析、自動化、または外部システムとの同期のために、サーバー側でメッセージイベントを受信します。イベントストリーム
クリック、開封、受信などのメッセージイベントをリアルタイムでデータウェアハウスにストリーミングします。
Journey Webhook
JourneyのステップからサーバーにHTTPリクエストを送信します。
WebプッシュWebhook
Webプッシュの表示、クリック、閉じるイベントのHTTPコールバック。
よくある質問
REST APIリクエストはどのように認証しますか？
AuthorizationヘッダーにREST APIキーをベアラートークンとして含めます：Authorization: Key YOUR_REST_API_KEY。OneSignalダッシュボードの設定 > キーとIDでキーを確認してください。詳細はキーとIDを参照してください。
クライアントSDKとサーバーSDKの違いは何ですか？
クライアントSDK（モバイルとWeb）はユーザーのデバイス上のアプリで動作します。サブスクリプション登録、権限プロンプト、アプリ内メッセージ、loginによるユーザー識別を処理します。サーバーSDKはバックエンドで動作し、REST APIを呼び出してメッセージの送信、ユーザーの管理、データのエクスポートを行います。
デバイス間でユーザーを識別するにはどうすればよいですか？
ユーザーがサインインした後、各デバイスでOneSignal.login("your_external_id")を呼び出します。OneSignalは同じExternal IDを持つすべてのサブスクリプションを1つのユーザーの下に統合します。実装の詳細についてはユーザーを参照してください。
本人確認の設定は必要ですか？
本人確認はオプションですが、本番アプリでは強くお勧めします。設定しないと、任意のクライアントが任意のExternal IDでloginを呼び出すことができます。本人確認を有効にするには、サーバー生成JWTを使用するようにOneSignal SDKを更新する必要があり、なりすましを防止できます。
需要帮助？与我们的支持团队聊天或发送邮件至
support@onesignal.com请包含以下信息：- 您遇到的问题详情以及复现步骤（如有）
- 您的 OneSignal 应用 ID
- 外部 ID 或订阅 ID（如适用）
- 您在 OneSignal 控制台中测试的消息 URL（如适用）
- 任何相关的日志或错误信息