メインコンテンツへスキップ
@capgo/capacitor-notifications デバイス API オープンソース

通知 Capacitor プラグイン

Capgoから、ユーザー検索、バッジ、統計、サイレントアップデート確認を備えたiOSおよびAndroidのネイティブプッシュ通知を送信します

インストール

bun add @capgo/capacitor-notifications bunx cap sync
npm、pnpm、または yarn
  • npm install @capgo/capacitor-notifications
  • pnpm add @capgo/capacitor-notifications
  • yarn add @capgo/capacitor-notifications

ガイド

Capacitor での通知機能の使い方

@capgo/capacitor-notifications の使用方法

Capgo から iOS/Android のネイティブプッシュ通知を送信。ユーザー検索、バッジ、フォアグラウンド/開封トラッキング、バックグラウンドコールバック、およびサイレントな Capgo による Live Update チェックに対応。

このプラグインは Capgo の通知パイプライン向けに構築されています。Capgo はプラットフォームの認証メタデータとキャンペーン制御データを Postgres に保存し、アクティブなデバイスの状態と配信イベントは Cloudflare Analytics Engine に書き込まれます。

インストール

ガイド付きセットアップには Capgo CLI を使用してください:

npx @capgo/cli@latest notifications setup com.example.app

手動インストール:

npm install @capgo/capacitor-notifications @capgo/capacitor-updater
npx cap sync

設定

import { CapgoNotifications } from '@capgo/capacitor-notifications'

await CapgoNotifications.configure({
  appId: 'com.example.app',
  autoUpdater: true,
  updateInstallMode: 'next',
})

署名済みユーザーを登録

発行 identityProof バックエンドから、次を使用して POST /notifications/recipients/proofその後、自分のログインが成功したらデバイスを登録します。

await CapgoNotifications.register({
  externalId: 'customer-user-123',
  identityProof,
  tags: ['paid'],
  attributes: { plan: 'team' },
  consent: true,
})

イベントをリッスン

await CapgoNotifications.addListener('notificationReceived', (notification) => {
  console.log('Received', notification)
})

await CapgoNotifications.addListener('notificationOpened', (event) => {
  console.log('Opened', event.notification.id)
})

await CapgoNotifications.addListener('backgroundNotification', async (event) => {
  try {
    console.log('Background payload', event.notification.data)
  } finally {
    await event.finish()
  }
})

iOSのセットアップ

有効にする プッシュ通知 と Background Modes > Remote notifications Xcode で選択してください。

リモート通知を以下から転送: ios/App/App/AppDelegate.swift:

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable: Any], fetchCompletionHandler completionHandler: @escaping (UIBackgroundFetchResult) -> Void) {
    NotificationCenter.default.post(name: Notification.Name("CapgoNotificationsRemoteNotification"), object: userInfo)
    completionHandler(.newData)
}

Android セットアップ

実行 npx cap sync androidCapgo で Android プラットフォームの認証情報を設定し、Android 13+ で通知権限をリクエストしてください。Google Play 開発者サービスが搭載された実機またはエミュレータでテストしてください。

デバッグ用チェックリスト

  • 実行 npx @capgo/cli@latest notifications setup com.example.app 以下のフォルダから capacitor.config.*.
  • Capgo で外部顧客 ID を使用して受信者を検索します。
  • デバイスにプラットフォームが設定されていることを確認してください android または ios かつ、権限が付与されていること。
  • 〜用の一時リスナーを追加: registrationChanged, notificationReceived, notificationOpenedや backgroundNotification.
  • ダッシュボードからテスト通知を送信します。
  • キュー済み、送信済み、受信済み、開封済みイベントの統計を確認します。
  • サイレントアップデートのチェックでは、以下を確認してください: @capgo/capacitor-updater がインストールされており、 autoUpdater が有効であること。

リファレンス全文

@capgo/capacitor-notifications の使用方法から次へ

使用している場合 @capgo/capacitor-notifications の使用方法 ネイティブのプッシュ通知を計画し、以下と連携させるには、 @capgo/capacitor-notifications 実装の詳細については、 デバッグ トラブルシューティング用、 @capgo/capacitor-updater サイレントアップデート確認用、および Capgo プラグインディレクトリ その他のネイティブプラグイン用。

よくある質問

Notifications プラグイン FAQ

Capacitor アプリに Notifications プラグインをインストールするにはどうすればよいですか?

"bun add @capgo/capacitor-notifications" (または "npm install @capgo/capacitor-notifications") を実行し、次に "bunx cap sync" を実行して、iOS および Android プロジェクトにネイティブの code を反映させます。その後、アプリの code で "@capgo/capacitor-notifications" からインポートしてください。

@capgo/capacitor-notifications は React、Vue、Angular で動作しますか?

はい。Notifications は Capacitor パッケージであるため、Ionic、React、Vue、Angular、Svelte、およびプレーンな JavaScript を含む、Capacitor 内で動作するあらゆる Web フレームワークで使用可能です。

@capgo/capacitor-notifications はどの Capacitor バージョンをサポートしていますか?

Capgo プラグインは Capacitor のメジャーバージョンに合わせています。使用している Capacitor のメジャーバージョンに一致するプラグインのメジャーバージョンを使ってください (例: Capacitor 8 ならプラグイン v8)。GitHub の README にある互換性テーブルに、メンテナンス中のバージョンが記載されています。

@capgo/capacitor-notifications は無料のオープンソースですか?

はい。code のソースコードは GitHub の https://github.com/Cap-go/capgo/tree/main/packages/capacitor-notifications/ で公開されており、パッケージは npm から無料でインストールできます。バグ報告やプルリクエストをお待ちしています。

App Storeの審査なしで、Notificationsを使用しているcodeをアップデートできますか?

プラグインのインストールやアップグレードはネイティブの code を変更するため、新しいストアビルドが必要です。その後は、プラグインを呼び出す JavaScript、HTML、CSS の変更を Capgo Live Updates で即座に配信できます。

アプリの審査を待たずに、Notificationsの変更をリリース

プラグインをストア用ビルドに組み込めば、Capgo live updates で JavaScript、HTML、CSS の変更を数分でユーザーに配信できます

Capgo から始める