PUSH API · v1a

対応範囲

現在対応している機能

Android・iOSのネイティブSDK：インストール登録、アドレスの更新と完全一致による解除、通知権限の観測、受信設定、永続的な同期。
FCMのFIDまたは従来の登録トークンモードと、APNsサンドボックス・APNs本番。プッシュサービスの設定とOSのコールバックはアプリ側で管理します。
新しいSDKの簡単初期化はサーバーのBASIC/VERIFIED設定を自動取得します。認証モードはプロジェクト環境ごとに1つで、その環境のすべてのアプリに適用されます。プロジェクト環境の最初のアプリはBASICで始まり、後から追加したアプリはその環境のモードに従います。BASICはexternal IDを使用し、VERIFIEDでは信頼できる顧客バックエンドがセッションを検証したJWTが必要です。設定取得の失敗からBASICへ切り替わりません。SDKが端末認証・紐付け・再試行を管理します。既存のidentify/logout/transferと併用せず、サーバーキーや秘密鍵をアプリに埋め込まないでください。
OS_DISPLAY通知、公開APIの単一・複数対象メッセージ、許可された一斉配信、状態・配信結果の確認、運用制御。各機能の権限と有効化条件を確認してください。
任意のiOS画像Notification Service Extension、アプリで登録したiOSボタン、アプリがフォアグラウンドで表示するAndroid通知のボタンヘルパー。SDKの導入だけでは拡張機能の追加やボタンの登録は行われません。
実際の受信・タップ記録にはメッセージのtrack_eventsとSDKのnotificationEventsEnabledが必要です。更新版SDKソースは収集が既定で有効ですが、保存済みの拒否が優先されます。ダッシュボードの新規メッセージは記録ONで開始し、既存下書き・複製やAPIで省略した値は変更しません。

このリリースで保証していないこと

Webプッシュ・ブラウザーSDK・React Native/Flutterラッパー・macOSアプリSDKは、このネイティブ連携の対応範囲外です。
メッセージAPIのdisplay_pathにAPP_DISPLAYを直接指定することはできません。AndroidのSDKによる表示は、対応SDKが登録した機能に基づいてサーバーが自動選択します。未記載のフィールドや未対応のenumを追加しないでください。
すべての端末への到達・画面表示・クリック率を測定する保証はありません。任意のコールバック観測には欠落があり、タップから受信を推定しません。AndroidのバックグラウンドOS_DISPLAYで任意のボタンを表示する機能も未対応です。
Maven Centralや公開Swift Package URLからすぐにインストールできるとは限りません。承認済みの配布物と互換性のあるバージョンを確認してください。
この静的ドキュメントには、認証情報を入力する試用画面や実際の送信ボタンはありません。サービスの可用性・配信成功率・リリース予定も保証していません。