Registration ID 検索機能ガイド

概要

regidSearchPath は、Registration ID 検索ページのアクセスパスをカスタマイズする Web Push SDK の設定オプションです。ユーザーが設定したパスにアクセスすると、SDK がセキュアな検証ダイアログを表示し、正しい Appkey を入力すると、現在のデバイスの Registration ID を確認できます。

PC版:

RegID 検索ダイアログ

モバイル:

RegID 検索ダイアログ

主な機能

  • 🔐 セキュア検証:Appkey 検証により、認可されたユーザーのみが Registration ID を表示可能
  • 📋 ワンクリックコピー:テスト・デバッグ用に Registration ID を素早くコピー
  • 🎨 分かりやすいUI:シンプルなダイアログインターフェース
  • ⚙️ 柔軟な設定:カスタムトリガーパスに対応

設定

regidSearchPath

  • : string
  • デフォルト: /engagelab/regid
  • 必須: いいえ
  • 説明: Registration ID 検索ダイアログを表示するパス

使い方

シナリオ1:デフォルトパス

regidSearchPath を設定しない場合、SDK はデフォルトパス /engagelab/regid を使用します。

MTpushInterface.init({ appkey: 'your-appkey', user_str: 'user-identifier', });
              
              MTpushInterface.init({
  appkey: 'your-appkey',
  user_str: 'user-identifier',
});

            
このコードブロックはフローティングウィンドウ内に表示されます

https://yourdomain.com/engagelab/regid にアクセスすると検索ダイアログが表示されます。

シナリオ2:カスタムパス

アプリの構成に合わせてカスタムパスを設定します。

MTpushInterface.init({ appkey: 'your-appkey', user_str: 'user-identifier', regidSearchPath: '/admin/push-debug' });
              
              MTpushInterface.init({
  appkey: 'your-appkey',
  user_str: 'user-identifier',
  regidSearchPath: '/admin/push-debug'
});

            
このコードブロックはフローティングウィンドウ内に表示されます

https://yourdomain.com/admin/push-debug にアクセスすると検索ダイアログが表示されます。

パスマッチ例

regidSearchPath: '/admin/regid' を設定した場合、以下のパスでダイアログが表示されます:

https://example.com/admin/regid
https://example.com/dashboard/admin/regid
https://example.com/admin/regid?debug=truehttps://example.com/#/admin/regidhttps://example.com/#/dashboard/admin/regid

注意事項

  • 表示タイミング:ダイアログは SDK の初期化が成功した後にのみ表示されます。
  • パス形式regidSearchPath は相対パス(例:/admin/regid)です。プロトコル、ドメイン、ポートは含めないでください。
  • フルページ読み込み:アドレスバーで該当パスにアクセスし、ページが読み込まれたときにパスがチェックされ、ダイアログが表示されます。フルリロードなしのクライアント側ルート変更ではトリガーされません。
  • 統合:パスは SDK を読み込み・初期化しているページに対応している必要があります。そうでない場合、検索ダイアログは表示されません。
  • マルチページアプリ:マルチページ構成では、そのパスで開かれる HTML ページで SDK を読み込み・初期化していることを確認してください。
  • マッチング:マッチングは通常大文字小文字を区別し、現在の URL パスに設定したパスが含まれるかを確認します(上記の例を参照)。
Icon Solid Transparent White Qiyu
お問い合わせ