概要
概要@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 | 低カードinalityの制御平面データ |
| アクティブデバイスの登録状態 | Cloudflare アナリティクスエンジン | アクティブデバイスの廉価な追加読み書きレジストリ |
| 通知イベント | Cloudflare アナリティクスエンジン | 廉価な送信済み、受信済み、開封済み、失敗した、バックグラウンドイベントの統計 |
アイデンティティモデル
セクション「アイデンティティモデル」Capgoはユーザーの一覧をアップロードすることを求めることはありません。また、デバイスのテーブルを維持することもありません。
- あなたのバックエンドは、実際の顧客ユーザーIDを知っています。
- あなたのバックエンドはCapgoに短期間の有効期限のものを要求します。
identityProof. - アプリは自身のユーザー認証が成功した後、__CAPGO_KEEP_0__に登録します。
externalId__CAPGO_KEEP_0__は、受信者とネイティブインストールのために決定論的な内部キーを導き出します。 - 同じCapgoに送信すると、同じユーザーのアクティブデバイスを再度見つけることができます。
- これにより、__CAPGO_KEEP_0__のPostgresにデバイスごとに通知行を保存する必要がなくなるため、ユーザーのデバイスを検索することができます。また、バッジを設定し、通知キャンペーンをターゲットにすることもできます。
externalIdCore Capabilities
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とともにデバイスを登録する- 認証済み外部ユーザーIDとともにデバイスを登録する
- アプリ起動またはトークン変更時にタグ、属性、同意、トークン状態を更新します。
- JavaScriptでフロントエンド通知を受け取ります。
- 通知受信と開封イベントを追跡します。
- バックグラウンドデータ通知を処理します。
- アプリバッジを設定、クリア、インクリメントします。
- Android通知チャンネルを作成します。
- 一時的な通知、キャンペーン通知、バッジ更新、静音アップデートチェックを送信します。
- トリガー
@capgo/capacitor-updater静音通知からトリガーします。
CapgoはCloudflareアナリティクスエンジンに通知イベントを書き込み、ダッシュボード統計を安価に維持します:
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-notificationsCapgoから続けて@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-notificationsを使用している場合 @capgo/capacitor-notifications プッシュメッセージの計画に使用している@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-notificationsを Getting Started セットアップのために デバッグのために @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updater @capgo/capacitor-updater __CAPGO_KEEP_0__ プラグインディレクトリ Capgo {"targetLanguage":"Japanese","pagePath":"/ja/docs/plugins/notifications/","protectedTokens":["Cloudflare","Capacitor","GitHub","Capgo","code","API","SDK","CLI","npm","bun"],"items":[{"text":"他のネイティブ プラグインについても"},{"text":"ページを編集"}]}