プッシュ通知機能

注釈

Cordova6.2プロジェクトでアドホックビルドしたアプリに対しては、リリースを選択する必要があります。

プッシュ通知に使用する Monaca バックエンド マネジメント API を、次に記します。

メソッド

解説

Push.send()

プッシュ通知を送信します。

Push.status()

プッシュ通知のステータスを取得します。

Push.send - プッシュ通知の送信

アプリに、プッシュ通知を送信します。

Push.send

パラメーター
pushProjectId

文字列

プッシュ通知 プロジェクト ID
platform

文字列

通知先となるプラットフォームです。 "android" または "ios" になります。

target

文字列

エンドユーザーの種類です。"app" になります。

buildType

文字列

アプリのビルドの種類です。 "debug""release""adhoc" のいずれかを選択します。

title

文字列

タイトルです ( Android のみ )。

message

文字列

送信されるメッセージです。

badge  

バッジ ( iOS のみ ) です。

extra_json json

JSON データです。

userOidList

文字列の配列

ユーザー ID を使用して、対象となるユーザーを絞り込みます ( 任意 )。

userQuery

文字列

ユーザーのプロパティーと MonaQL クエリーを使用して、対象となるユーザを絞り込みます ( 任意 )。

‘country == “US” && age > 20’

userQueryBindParams

配列

userQuery 内にプレースホルダーがある場合には、値に置き換えます ( 任意 )。

userQuery が ‘country == ? && age > ?’ の場合、[“US”, 20] になります。

deviceIdList

文字列の配列

デバイス ID を使用して、対象となる端末を絞り込みます ( 任意 )。

注釈

deviceIdListuserOidListuserQuery は、同時に使用できません。

戻り値
queueIdList

プッシュキュー ID ( push queue id ) の一覧です。”

エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

Push.status - プッシュ通知のステータスの取得

プッシュ通知のステータスを取得します。

Push.status

パラメーター
pushProjectId

文字列

プッシュ通知 プロジェクト ID
queueId

文字列

プッシュキュー ID ( Push queue ID / queueIdList から取得 )

戻り値
status

ステータス ( 完了 など ) です。

numTarget

対象となる受信者の数です。

numPushed

受信が成功した数です。

numFailed

受信が失敗した数です。

createdAt

作成日時です。

pushStartedAt

開始日時です。

pushFinishedAt

完了日時です ( 成功または失敗に関わらず )。

エラーコード

エラー オブジェクト形式で、エラーが返ってきます。

-32602

不正なパラメーターです。

プッシュ通知 プロジェクト ID

プッシュ通知 プロジェクト ID とは、プッシュ通知毎の ID です。次の手順で確認できます。

  1. Monaca クラウド IDE 上の アイコンをクリックして、 Monaca バックエンド の管理画面を開きます。

  2. 歯車 のアイコンをクリックして、 バックエンド設定... を開きます。下のスクリーンショットをご確認ください。

../../../../_images/backend_setting.png
  1. Backend Settings 画面が表示されます ( 中央の左側 )。次に、 プッシュ通知 の項目をクリックします。スクロールで下に行き、 アプリの 「 プッシュ通知プロジェクト ID 」 を確認します ( 下のスクリーンショットを参照のこと )。

../../../../_images/push_projectID.png