概要
Overview@capgo/capacitor-notifications connects a Capacitor app to Capgo’s native notification pipeline. Your app registers a signed customer user ID with Capgo, Capgo keeps the latest active device state in Cloudflare Analytics Engine, and you can send notifications, set badges, inspect delivery stats, and trigger silent Capgo live-update checks from the Capgo dashboard or API.
The feature is designed to avoid a high-cardinality notification device table in Capgo Postgres. Postgres stores only low-cardinality control plane data such as app settings, platform credential metadata, campaign drafts, schedules, and aggregate campaign records. Active device state and notification events are append-only Analytics Engine rows.
What Capgo Stores
Section titled “What Capgo Stores”| データ | データがどこに格納されているか | なぜ |
|---|---|---|
| プラットフォームクレデンシャルメタデータ | Capgo Postgres | アプリのセットアップとパーミッションの管理に必要です。 |
| プライベートプラットフォームシークレット | ワーカーエンビロメント | プライベートクレデンシャルを顧客向けのテーブルに保存しないようにします。 |
| キャンペーンの草稿と設定 | Capgo Postgres | 低カードイニシャル制御プレーンデータ |
| アクティブデバイスの登録状態 | Cloudflare アナリティクスエンジン | アクティブデバイスの低コストの追加読み取り専用レジストリ |
| 通知イベント | Cloudflare アナリティクスエンジン | コストパフォーマンスの高い送信済み、受信済み、開封済み、失敗した、バックグラウンドイベントの統計 |
アイデンティティモデル
セクション「アイデンティティモデル」Capgoはユーザーリストをアップロードすることを求めることはありません。また、デバイステーブルを維持することもありません。
- あなたのバックエンドは、実際の顧客ユーザーIDを知っています。
- あなたのバックエンドはCapgoに短期間の有効期限のものを求めます。
identityProof. - アプリは自身のユーザー認証が成功した後、__CAPGO_KEEP_0__に登録します。
externalId__CAPGO_KEEP_0__は、受信者とネイティブインストールのために決定論的な内部キーを導き出します。 - 同じCapgoに送信すると、同じユーザーに通知を送信できます。
- これにより、__CAPGO_KEEP_0__ Postgresにデバイスごとの通知行を保存する必要がなくなるため、ユーザーのデバイスを検索、バッジを設定、通知キャンペーンをターゲット設定できます。
externalId基本機能
This lets you look up a user’s devices, set badges, and target notification campaigns without storing per-device notification rows in Capgo Postgres.
認証済み外部ユーザーIDでデバイスを登録する
デバイスを認証済み外部ユーザーIDで登録する- Register devices with an authenticated external user ID.
- アプリ起動またはトークン変更時にタグ、属性、同意、トークン状態を更新します。
- JavaScriptでフロントエンド通知を受け取ります。
- 通知受信および開封イベントを追跡します。
- バックグラウンドデータ通知を処理します。
- アプリバッジを設定、クリア、インクリメントします。
- Android通知チャンネルを作成します。
- 一時的な通知、キャンペーン通知、バッジ更新、静音の更新チェックを送信します。
- 静音通知からトリガーします。
@capgo/capacitor-updater__CAPGO_KEEP_0__は__CAPGO_KEEP_1__の分析エンジンに通知イベントを書き込み、ダッシュボードの統計が安価になるようにします。
Capgo writes notification events to Cloudflare Analytics Engine so dashboard stats stay cheap:
queuedsentprovider_acceptedreceivedopenedfailedpermission_changedbackground_startedbackground_finished
統計情報は、受信者ごとの永続的な記録ではありません。分析エンジンの保持期間は、有効なデバイスが登録の更新を定期的に行うことを意味します。
Public API
「Public API」| メソッド | 説明 |
|---|---|
configure | Capgo アプリ ID、API ホスト、およびアップデータ統合の動作を設定します。 |
register | 外部顧客ユーザー ID でインストールを登録します。 |
setExternalId | ログインまたはアカウント切り替え後に外部顧客ユーザー ID を変更します。 |
setTags | ターゲットアウディエンスのタグを使用するタグを置き換えます。 |
setBadge | ネイティブアプリのバッジを設定します。 |
clearBadge | ネイティブアプリのバッジをクリアします。 |
incrementBadge | ネイティブアプリのバッジをインクリメントします。 |
enableUpdaterIntegration | 静的更新チェックハンドリングを有効にする @capgo/capacitor-updater. |
runUpdateCheck | テスト用にアップデート統合を手動で実行します。 |
trackReceived | 受信されたイベントを手動で書き込みます。 |
trackOpened | 開いたイベントを手動で書き込みます。 |
addListener('notificationReceived') | JavaScriptが有効なときに通知を受け取ったときに発火します。 |
addListener('notificationOpened') | ユーザーが通知を開いたときに発火します。 |
addListener('backgroundNotification') | バックグラウンドデータ通知のために発火し、 finish(). |
addListener('registrationChanged') | ネイティブプッシュトークンが変更されたときに発火します。 |
配信保証
配信保証ネイティブプッシュは少なくとも1回。キャンペーンは再試行され、プラットフォームが繰り返されたメッセージを受け入れる場合、デバイスは重複メッセージを受信する可能性があります。更新チェックのためにコラプスIDを使用し、バックグラウンドワークを無害化してください。
iOSのバックグラウンド通知はベストエフォートです。OSはバッテリー、ユーザーの行動、強制終了状態、システムポリシーに基づいてバックグラウンド実行を抑制またはスキップする可能性があります。静的な通知に依存してハードデッドラインを確実に実行しないでください。
Capgoから続けて@capgo/capacitor-notifications
「Capgoから続けて@capgo/capacitor-notifications」Capgoから続けて@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-notificationsを使用している場合 Capgoから続けて@capgo/capacitor-notifications プッシュメッセージの計画に@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-notificationsを使用し、 は設定のための はトラブルシューティングのための Capgoから続けて@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updater 静的更新のチェックのための、 @capgo/capacitor-updater __CAPGO_KEEP_1__ Capgo {"targetLanguage":"Japanese","pagePath":"/ja/docs/plugins/notifications/","protectedTokens":["Cloudflare","Capacitor","GitHub","Capgo","code","API","SDK","CLI","npm","bun"],"items":[{"text":"他のネイティブ プラグインについても"},{"text":"ページを編集する"}]}