Monaca Docs
  • Monaca とは
  • 最初のアプリを作る
  • アプリをテストする
  • Monaca リリース情報
    • iOS プライバシーマニフェスト対応
    • 「ニフクラ mobile backend」終了に関するお知らせ
    • プラグイン uses-permission タグの重複修正機能
    • Cordova 12 の変更点
    • iOSストア版Monaca デバッガー配信停止と代替機能のご案内
    • iOS App Store への送信エラー (ITMS-90165)
    • cordova-custom-configのビルドエラー
    • Cordova 11 の変更点
    • Cordova 10 の変更点
    • Cordova 9.0 の変更点
    • 利用規約の変更
    • 新しい Monaca CLI と Localkit
    • CordovaからCapacitorへの移行
  • Monacaガイド
    • Monaca での開発の概要
    • Monaca クラウド IDE
      • 概要
      • Monaca クラウド IDE の機能
      • ターミナル機能
      • エディターのショートカット一覧
      • プロジェクトの構成
        • ファイル・フォルダー構成
        • JS/CSS コンポーネント
        • Cordova プラグイン
        • ユーザー Cordova プラグイン
      • バージョン管理
        • 概要
        • GitHub との連携
        • Git SSH との連携
      • Monaca CI
        • 概要
        • アプリ配信 / 配布サービス (デプロイサービス)
        • Appetize.ioへの配信
        • DeployGateへの配信
        • Firebase への配信
      • ビルド
        • iOS アプリのビルド
          • iOS アプリのビルド
          • Monaca と Xcode 間でのビルド設定の再利用
        • Android アプリのビルド
        • Windows アプリのビルド
        • Electron アプリのビルド
          • Windows アプリのビルド
        • PWA アプリのビルド
        • ビルド環境の設定
        • ビルド履歴一覧
        • 一般的なビルドとアップロードエラー
      • 配布方法
        • App Store での配布
          • App Store Connect ガイド
          • iOS アプリ アップロード機能
        • Google Play での配布
        • 公式ストア経由以外での配布
      • パッケージダウンロード機能
      • チュートリアル
    • Monaca Localkit
      • 概要
      • ペアリングとデバッグ
      • リモートビルドと配布申請
      • トラブルシューティング
        • インストール ( Windows の場合 )
        • インストール ( Mac OS X の場合 )
        • アンインストール時 ( Windows の場合 )
        • 不完全なファイル・フォルダー構成
        • プレビューウィンドウが更新されない
        • Error while installing
        • nodeのインストールが必要です
      • チュートリアル
    • Monaca CLI
      • 概要
      • Monaca CLI コマンド
      • ペアリングとデバッグ
      • リモートビルドと配布申請
      • トラブルシューティング ガイド
      • チュートリアル
    • Monaca デバッガー
      • 機能の概要
      • インストール方法
        • Android 向けの Monaca デバッガー
        • iOS 向け Monaca デバッガー
        • Android エミュレーター向け Monaca デバッガー
      • 使用例
      • iOS カスタムビルド版デバッガー
      • iOS シミュレータービルド
      • トラブルシューティング ガイド
      • チュートリアル
    • チームダッシュボード
    • クイックビューア
    • 他のプラットフォームからの移行
      • 移行時の確認ポイント
      • クラウドIDE プレビュー機能の設定
      • Angular からの移行
      • Ionic からの移行
      • React からの移行
      • Vue からの移行
      • Telerik からの移行
  • 🛠️アプリビルド
    • iOS ビルド
      • 秘密鍵とCSRの作成
      • 証明書の作成
      • プロビジョニング・プロファイルの更新
  • チュートリアル
    • Monaca クラウド IDE チュートリアル
      • パート 1 : プロジェクトの作成
      • パート 2 : Monaca クラウド IDE と Monaca デバッガーとの連携
      • パート 3 : Monaca アプリのビルド
      • パート 4 : Monaca アプリの配布申請
    • Monaca Localkit チュートリアル
      • パート 1 : プロジェクトの作成
      • パート 2 : Monaca Localkit と Monaca デバッガーとの連携
      • パート 3 : Monaca アプリのビルド
      • パート 4 : Monaca アプリの配布申請
    • Monaca CLI チュートリアル
      • パート 1 : プロジェクトの作成
      • パート 2 : Monaca CLI と Monaca デバッガーとの連携
      • パート 3 : Monaca アプリのビルド
      • パート 4 : Monaca アプリの配布申請
    • Electron アプリ開発
      • NPMパッケージの利用方法
      • Web APIの利用方法
    • バーコードスキャナープラグイン
    • Cordova Sqlite Storage プラグイン
    • Cordova Google Analytics プラグイン
    • Cordova Firebase プラグイン
    • Cordova In-app Purchase プラグイン
    • Cordova AppVersion プラグイン
    • Cordova Ionic Keyboard プラグイン
    • Cordova Social Sharing プラグイン
    • Phonegap Push プラグイン
  • APIの解説
    • Monaca API
      • Monaca クラウド & リモートビルド API
      • ユーティリティ
    • 基本プラグイン
      • Cordova 12.0
        • Battery プラグイン
        • Camera プラグイン
        • Device プラグイン
        • Device Motion プラグイン
        • Device Orientation プラグイン
        • Dialog プラグイン
        • File プラグイン
        • Geolocation プラグイン
        • InAppBrowser プラグイン
        • Media プラグイン
        • Media Capture プラグイン
        • Network Information プラグイン
        • Vibration プラグイン
        • StatusBar プラグイン
      • Cordova 11.0
        • Battery プラグイン
        • Camera プラグイン
        • Device プラグイン
        • Device Motion プラグイン
        • Device Orientation プラグイン
        • Dialog プラグイン
        • File プラグイン
        • Geolocation プラグイン
        • InAppBrowser プラグイン
        • Media プラグイン
        • Media Capture プラグイン
        • Network Information プラグイン
        • Splashscreen プラグイン
        • Vibration プラグイン
        • StatusBar プラグイン
      • Cordova 10.0
        • Battery プラグイン
        • Camera プラグイン
        • Device プラグイン
        • Device Motion プラグイン
        • Device Orientation プラグイン
        • Dialog プラグイン
        • File プラグイン
        • Geolocation プラグイン
        • InAppBrowser プラグイン
        • Media プラグイン
        • Media Capture プラグイン
        • Network Information プラグイン
        • Splashscreen プラグイン
        • Vibration プラグイン
        • StatusBar プラグイン
        • Whitelist プラグイン ( Android 専用 )
      • Cordova 9.0
        • バッテリー情報の取得 プラグイン
        • カメラ操作 プラグイン
        • 住所録の取得 プラグイン
        • 端末情報の取得 プラグイン
        • 端末のモーション検知 プラグイン
        • 端末のオリエンテーション検知 プラグイン
        • ダイアログの制御 プラグイン
        • ファイル操作 プラグイン
        • ファイル転送 プラグイン
        • 位置情報の取得 プラグイン
        • 表記の国際化対応 プラグイン
        • InAppBrowser プラグイン
        • メディア操作 プラグイン
        • メディアキャプチャー プラグイン
        • ネットワーク情報の取得 プラグイン
        • スプラッシュスクリーンの制御 プラグイン
        • バイブレーションの制御 プラグイン
        • ステータスバーの制御 プラグイン
        • ホワイトリストへの登録 プラグイン ( Android 専用 )
    • サードパーティー製プラグイン
      • AdvancedHTTPプラグイン
      • PhoneGap BarcodeScanner
      • Custom Config
      • Datepicker
      • Share ( Android 向け )
      • WebIntent ( Android 向け )
    • Monaca 提供プラグイン
      • アプリロジック暗号化 (Encrypt プラグイン)
      • In-App アップデーター (In-App Updater)
      • セキュア ストレージ
      • NFC リーダー
      • バーコードスキャナー
      • Androidビルドメモリサイズ設定
    • 外部サービス連携
      • Repro
      • AppsFlyer
    • 設定ファイル
      • Android
        • Android の設定
        • config.xml
        • AndroidManifest.xml
      • iOS
        • iOS の設定
        • config.xml
        • MonacaApp-info.plist
  • サンプル & Tips
    • Firestoreを利用する
    • サンプルアプリ
      • Twitter アプリ
      • Facebook アプリ
      • 広告 アプリ (AdMob)
      • Hello World アプリ
      • メモ帳アプリ
      • ブロック崩しゲーム
      • Flickrアプリ
      • TODO管理 アプリ
      • 電車図鑑アプリ
      • 時計アプリ
      • 誕生年の計算アプリ
      • おみくじ占いアプリ
      • RSS リーダーアプリ
    • 開発 Tips
      • 音楽の再生方法
      • スプラッシュ画像の制御方法
      • データベースの利用方法
  • Webpack5への更新
  • 機能
    • SNS 認証
    • プッシュ通知
    • データベース
  • 外部サービス連携ガイド
    • Firebase
      • アプリの登録と設定ファイルの取得
  • 移行ガイド
    • ニフクラ mobile backend
      • プッシュ通知
        • Firebaseサービスの設定
        • ソースコードの移行
      • データストア
        • ソースコードの移行
        • データの移行
        • データ移行スクリプト実行手順
      • 会員管理・認証
        • 会員管理 データの移行
        • Firebase Authentication パスワード再設定サンプル
        • Firebase Authenticationを使用したユーザー名認証の方法
      • スクリプト
        • Firebase Functions開発環境の作成
        • サンプル共通項目
        • サンプル1(GETサンプル)
        • サンプル2(POSTサンプル)
        • サンプル3(DELETEサンプル)
        • エミュレータでのテスト
      • ファイルストア
        • ファイルアップロード
        • ファイル検索
        • ファイル一覧表示
        • ファイル削除
  • FAQ
    • 概要
    • IDE
    • ビルド
    • リリース
    • 契約プラン
    • アプリケーション
    • 使用方法
    • Freeプラン
    • デバッガー
  • 対応環境
  • トラブルシューティング
    • プレビューログがリロードを繰り返す (Vue packages version mismatch error)
  • Monaca製品サイト
  • 運営会社
  • English
GitBook提供
このページ内
  • デモ
  • IOSの準備
  • Firebase ( プッシュ通知 ) の設定
  • iOS の場合
  • Android の場合
  • Monaca クラウド IDE でプラグインを有効にする
  • 使い方
  • API リファレンス
  • init()
  • hasPermission()
  • getApplicationIconBadgeNumber()
  • setApplicationIconBadgeNumber()
  • push.on()

役に立ちましたか?

  1. チュートリアル

Phonegap Push プラグイン

前へCordova Social Sharing プラグイン次へAPIの解説

最終更新 3 年前

役に立ちましたか?

非推奨プラグイン

この Cordova プラグインでは、プッシュ通知の登録と受信を行います。

  • Repo:

  • Plugin ID/Package Name: phonegap-plugin-push

  • Tested Version: 2.3.0

カスタムビルドデバッガーでは、プッシュ通知を確認することはできません。 プッシュ通知を確認する場合は、デバッグビルドかリリースビルドにてご確認ください。

デモ

IOSの準備

iOS 向けのプッシュ通知を使用する場合は、APNs の認証キーまたは APNs 証明書が必要になります。 ここでは、iOS デバッグビルド用の Development APNs 署名書の作成方法を説明します。

リリースビルドでは、Production APNs 証明書が必要になります。

2. Certificates, Identifiers & Profiles を選択します。

3. APNs 証明書を作成する場合は、プッシュ通知を有効にした App ID が必要になります。Identifiers 項目の App IDs 選択し、右上隅の + ボタンをクリックします。

4. 次のような App ID 情報を入力します。

  • App Description: アプリ名を入力します ( 例:Cordova Firebase Demo )

  • Explicit ID: プッシュ通知では、ワイルドカードの App ID を使用できないため、このオプションを選択します。 アプリの固有の識別子( io.monaca.firebase など )を入力します。

5. App Services 項目の Push Notifications オプションをチェックし、Continueをクリックします。

6. Confirm your App ID ページにリダイレクトされます。 Register をクリックします。

7. iOS App IDs ページで作成した App ID を選択し、Edit をクリックします。

8. Push Notifications 項目にある Development SSL Certificate の Create Certificate をクリックします。

9. Continue をクリックします。

10. Choose File をクリックし、CSR ファイルを選択します。 CSR ファイルは、Monaca クラウド IDE の 設定 → iOS ビルド設定 から取得することができます。 秘密鍵と CSR の生成 をクリックし、CRSファイルを作成後 エクスポート ボタンをクリックしてダウンロードします。

11. 次に、Continue をクリックします。 証明書の準備でき、ダウンロード可能になったら証明書をダウンロードします。

12. ダウンロードした証明書を iOS ビルド設定 の 証明書のアップロード ボタンをクリックしてアップロードします。

13. Monacaに登録された証明書 に表示された証明書の エクスポート アイコンをクリックして p12 ファイルをエクスポートします。次の項目の Firebase の設定に必要になります。

Firebase ( プッシュ通知 ) の設定

2. Firebase Console にログインします。

3. プロジェクトを追加 をクリックします。

4. プロジェクト情報を入力し、 プロジェクトを作成 をクリックします。 その後、プロジェクト概要ページにリダイレクトされます。

プロジェクトを作成後、各プラットフォーム用プッシュ通知の設定を行うことができます。

iOS の場合

1. プロジェクトの設定 を選択します。

2. [全般] 項目で アプリを追加 をクリックし、iOS を選択します。

3. iOS のバンドル ID を入力します。( 設定 → iOS アプリ設定 ) で確認することができます)。 次に、アプリの登録 をクリックします。

4. GoogleService-Info.plist ファイルをダウンロードし、プロジェクトのルートフォルダに配置します。 次に、 続行 をクリックします。

5. [Firebase SDK の追加] では、Monacaで開発するアプリは、ネイティブアプリではないため、 続行 をクリックします。 次に、終了 をクリックして設定を完了します。その後、Firebase の概要ページに iOS アプリが表示されます。

6. 作成したプロジェクトに APNs 証明書を追加します。 プロジェクトの設定 に移動し、 クラウド メッセージングを選択します。

7. iOS アプリの設定 項目で、APNs 認証キーまたは APNs 証明書をアップロードします。

以上で、iOS 用の設定は完了です。

Android の場合

1. プロジェクトの設定 を選択します。

2. [全般] 項目で アプリを追加 をクリックし、Android を選択します。

3. パッケージ名を入力します ( 設定 → Android アプリ設定で確認することができます) 。 次に、アプリの登録 をクリックします。

4. google-services.json ファイルをダウンロードし、プロジェクトのルートフォルダに配置します。 次に、 続行 をクリックします。

5. [Firebase SDK の追加] では、Monacaで開発するアプリは、ネイティブアプリではないため、 続行 をクリックします。 次に、終了 をクリックして設定を完了します。その後、Firebase の概要ページに iOS アプリが表示されます。

Monaca クラウド IDE でプラグインを有効にする

  1. IDE メニューから 設定 → Cordova プラグインの管理 へ移動します。

  2. Cordova プラグインのインポートボタンをクリックします。 次に、[ZIP ファイル] または [パッケージ名 / URL] を使用してプラグインをインポートします。

使い方

プラグインをプロジェクトにインポート後、プッシュ通知の初期化を行います。 deviceready イベント後、プラグイン API 使用します。 例:

document.addEventListener("deviceready", onDeviceReady, false);        
function onDeviceReady() {

    // Notification initialization
    push = PushNotification.init({
        ios: {
            badge: true
        }
    });
    
    // Checking notification permission
    $interval(checkNotifPermiss, 500);
    // Updating App Icon Badge Number
    $interval(updateAIBN, 500);  

    // When receiving a push notification
    push.on('notification', data => {
        receiveNotifCB(data);
    });
}

API リファレンス

init()

プッシュ通知の初期化を行います。

PushNotification.init(options)

パラメーター

パラメーター名

型

説明

options

Object

すべての対象プラットフォームの関連する固有のオプションを記述するオブジェクト。

  • iOS の場合

すべての iOS の Boolean オプションは、String として指定することもできます。

属性

型

標準値

説明

ios.voip

Boolean

false

[オプション] trueに設定されている場合、VoIP プッシュ通知を受信するように端末が設定され、VoIP 通知は、notification イベントで処理されるサイレント通知のため、他のオプションは無視されます。

ios.alert

Boolean

false

[オプション] true に設定されている場合、端末は通知の受信時にアラートを表示します。*

ios.badge

Boolean

false

[オプション] true に設定されている場合、端末は通知の受信時にバッジ番号を設定します。*

ios.sound

Boolean

false

[オプション] true に設定されている場合、端末は通知の受信時に音声を再生します。*

ios.clearBadge

Boolean

false

[オプション] true に設定されている場合、アプリの起動時にバッジがクリアされます。

ios.categories

Object

{}

*: init メソッドが初めて実行されるときに設定されるオプションの値によって、アプリがどのように動作するかが決まります。 init メソッドで値が設定された場合でも、 設定 → 通知 → アプリ名 からユーザが手動で設定を変更することができます。これは通常のiOSの動作になります。

  • Android の場合

属性

型

標準値

説明

android.icon

String

[オプション] small-icon として使用する画像リソース名。 リソース名には、拡張子は含まれません。

android.iconColor

String

android.sound

Boolean

true

[オプション] true に設定されている場合、プッシュデータで指定された音声またはデフォルトのシステム音が再生されます。

android.vibrate

Boolean

true

[オプション] true に設定されている場合、端末は通知を受け取ると振動します。

android.clearBadge

Boolean

false

[オプション] true に設定されている場合、アイコンバッジは初期化時にクリアされ、プッシュメッセージが処理される前にクリアされます。

android.clearNotifications

Boolean

true

[オプション] true に設定されている場合、アプリが閉じられたときに保留中の通知をすべてクリアします。

android.forceShow

Boolean

false

[オプション] アプリがフォアグラウンドにあるときの通知動作を制御します。true の場合、アプリがフォアグラウンドになると、アプリがバックグラウンドのときと同じように、通知領域に通知が表示されます ( on(‘notification’) コールバックは、ユーザーが通知をクリックしたときにのみ実行されます )。false で、アプリがフォアグラウンドの場合、on(‘notification’) コールバックが実行されます。

android.topics

Array

[]

[オプション] 配列 に1 つ以上の文字列が含まれている場合、各文字列は FcmPubSub トピックの購読に使用されます。

android.messageKey

String

message

[オプション] 通知のテキストを検索するためのキー。

android.titleKey

String

title

[オプション] 通知のタイトルを検索するためのキー。

戻り値

  • pushObject

例

const push = PushNotification.init({
  android: {},
  browser: {
    pushServiceURL: 'http://push.api.phonegap.com/v1/push'
  },
  ios: {
    alert: 'true',
    badge: true,
    sound: 'false'
  },
  windows: {}
});

hasPermission()

プッシュ通知許可が端末で許可されているか確認します。

PushNotification.hasPermission(successHandler)

パラメーター

パラメーター名

型

説明

successHandler

Function

API がアクセス許可を正常に取得した際に実行されます。

Callback パラメーター

  • successHandler

パラメーター名

型

説明

data.isEnabled

Boolean

プッシュ通知の許可の状態を取得します。

戻り値

  • Promise

例

PushNotification.hasPermission(data => {
  if (data.isEnabled) {
    console.log('isEnabled');
  }
});

getApplicationIconBadgeNumber()

アプリが実行されていないときに表示されている現在のバッジの数を取得します。

push.getApplicationIconBadgeNumber(successHandler, errorHandler)

パラメーター

パラメーター名

型

説明

successHandler

Function

API がアイコンバッジ番号を正常に取得した際に実行されます。

errorHandler

Function

アイコンのバッジ番号を取得する際に API がエラーを検出したときに実行されます。

Callback パラメーター

  • successHandler

パラメーター名

型

説明

n

Number

現在のバッジカウントの整数。

戻り値

  • Promise

例

push.getApplicationIconBadgeNumber(
    n => {
        $scope.aibn = n;
    },
    () => {
        console.log('Error getting the number');
    }
);

setApplicationIconBadgeNumber()

アプリが実行されていないときに表示されるバッジの数を設定します。

push.setApplicationIconBadgeNumber(successHandler, errorHandler, count) 

パラメーター

パラメーター名

型

説明

successHandler

Function

API がアイコンバッジ番号を正常に取得した際に実行されます。

errorHandler

Function

アイコンのバッジ番号を取得する際に API がエラーを検出したときに実行されます。

count

Number

バッジに表示する数を指定します。0 を指定した場合は、バッジがクリアされます。 各 notification イベントには、バッジを正しい数に設定するために使用できる data.count の値が含まれています。

戻り値

  • Promise

例

push.setApplicationIconBadgeNumber(
    () => {
        alert("Successfully setting the badge number!");
    },
    () => {
        alert("Fail to set the badge number. Something went wrong...");
    },
    badgeNum
);

push.on()

notification イベントは、プッシュ通知サービスから送信されたプッシュ通知を受信した際に実行されます。

push.on('notification', callback)

Callback パラメーター

パラメーター名

型

説明

data.message

String

プッシュ通知サービスから送信されたプッシュメッセージのテキスト。

data.title

String

[オプション] プッシュ通知サービスから送信されたプッシュメッセージのタイトル。

data.count

String

iOS / Android のバッジに表示されるメッセージ数、または Android の通知領域のメッセージ数。Windows の場合、数またはステータスグリフのバッジ通知の値を表します。

data.sound

String

通知の受信時に再生される音声ファイルの名前。

data.image

String

通知に表示されるイメージファイルのパス。

data.launchArgs

String

プッシュ通知からの起動時にアプリに渡される引数。これは通知がバックグラウンドで受信されたときに機能します。( Windows のみ )

data.additionalData

Object

[オプション] 上記のプロパティに適合しないプッシュ通知サービスによって送信されたデータのコレクション。

data.additionalData.foreground

Boolean

アプリがフォアグラウンドでプッシュ通知を受け取ったかどうか。

data.additionalData.coldstart

Boolean

プッシュ通知をクリックしてアプリを起動する場合は true、アプリがすでに起動されている場合は false になります。

data.additionalData.dismissed

Boolean

プッシュ通知がユーザによって却下された場合は true が設定されます。

戻り値

  • Promise

例

push.on('notification', data => {
  console.log(data.message);
  console.log(data.title);
  console.log(data.count);
  console.log(data.sound);
  console.log(data.image);
  console.log(data.additionalData);
});

既に をお持ちの場合は、以下の手順に従って Development APNs 証明書を作成してください。

1. から、Account に移動します。

1. にアクセスします。

このページでは、 で使用されている主な API についてのみ説明します。API リファレンスについては、 を参照してください。

[オプション] iOS のアクションボタンを有効にするために必要なデータです。詳細については、 を参照してください。

[オプション] Android 5.0 以降の small-icon の背景色を設定します。

Apple Developer Program
Apple Developer page
Firebase Console
デモ
こちら
Action Buttons on iOS
サポートされている形式
https://github.com/phonegap/phonegap-plugin-push
プロジェクトをインポート