サーバー構築不要！スマートフォンアプリ向けの新クラウド

トップ >ドキュメント >REST API リファレンス:プッシュ通知更新

REST API リファレンス

共通ドキュメント

プッシュ通知更新

プッシュ通知更新APIについて

未配信のプッシュ通知に対して、プッシュ通知内容の更新を行います。

基本仕様

  • APIパス：/push/オブジェクトID
  • メソッド：PUT

リクエストヘッダー

シグネチャやAPIキーなどの詳細は「共通フォーマット」を参照してください。

フィールド名 内容
Content-Type application/json

リクエストコンテント

パラメータ名 説明 データ型 必須
deliveryTime 配信時刻 日付
immediateDeliveryFlag 即時配信 真偽値
target ターゲット 配列
searchCondition 検索条件 オブジェクト
title タイトル 文字列
message メッセージ 文字列
userSettingValue ユーザー設定値 オブジェクト
deliveryExpirationDate 配信期限日 日付
deliveryExpirationTime 配信期限時間 文字列
action アクション 文字列
dialog ダイアログ通知有効化フラグ 真偽値
badgeIncrementFlag バッジ数増加フラグ 真偽値
badgeSetting バッジ数 数値
sound 音楽ファイル 文字列
contentAvailable content-available 真偽値
richUrl リッチプッシュURL 文字列
category カテゴリ 文字列
acl ACL オブジェクト
  • 配信時刻か、即時配信のどちらかが指定されている必要があります。
  • ユーザー設定値には、プッシュ通知に含める独自情報をJSON形式で設定できます。
    • pushIdはシステムで使用するキー値なので使用不可です。
  • 配信期限日と配信期限時間は、どちらかしか設定できません。
    • 配信期限時間は、時間単位または日単位の指定が可能です。
    • 時間単位指定の場合:{"deliveryExpirationTime":"3 hour"}
    • 日単位指定の場合:{"deliveryExpirationTime":"3 day"}
    • 未指定時の初期値は「（空文字）」となります。
  • 検索条件は、JSON形式で配信端末のキーと値を指定します。
    • 配信端末登録時に、任意の情報を設定することで、検索条件を拡張することも可能です。
    • FCM対応したプッシュ通知を使用したい場合は以下の手順を実施してください。
    • installationクラスに「pushType」フィールドを作成してください。その後、FCM対応したプッシュ通知を送りたいAndroid端末のレコードの「pushType」フィールドに「fcm」と入力してください。このフィールドに「fcm」と入力されたAndroid端末のみ、FCM対応したプッシュ通知を送信します。

検索条件の例

    "searchCondition": {
        "channels": "ch1",
        "appVersion": "1.0"
       }
  • アクション、ダイアログ通知有効化フラグは、Android端末への配信時に設定可能です。
    • ダイアログ通知機能をアプリ側で実装していない場合は、このフラグが無視され、通常のプッシュ通知になります。
  • バッジ数増加フラグ、バッジ数、音楽ファイル、content-availableは、iOS端末への配信時に設定可能です。
    • content-availableとバッジ数増加フラグは、どちらかしか設定できません。
    • content-availableとバッジ数増加フラグがtrueに設定されている場合、バッジ数はnullしか指定できません。

HTTPステータス

ステータスコード 説明
200 更新完了

レスポンスヘッダー

フィールド名 値
Content-Type application/json

レスポンスコンテント

パラメータ名 説明 データ型 備考
updateDate 更新日時 日付

リクエストサンプル

curl -v -X PUT  \
 -H "X-NCMB-Apps-Session-Token:46MnVgUbwHIXIHp9mowIeh7r2"\
 -H "X-NCMB-Application-Key: 549116a86b0ebbec4832d4086a56f36c82a5d64bc6528fa5e6220be76db5ef45" \
 -H "X-NCMB-Timestamp: 2013-08-14T15:46:25.543" \
 -H "X-NCMB-Signature: 2kvCGaNEM8Qz7TBXlOJi+ReRwOQ5e7WAeoFjnCKowYM=" \
 -H "Content-Type: application/json" \
 -d '{"message":"hello"}'\
 https://mbaas.api.nifcloud.com/2013-09-01/push/c28kG8CQuCAMZVVl

レスポンスサンプル

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8

{"updateDate":"2013-08-30T05:04:19.045Z"}

お探しの内容が見つからなかった場合はユーザーコミュニティ もご活用ください。（回答保証はいたしかねます）
なお、 Expertプラン以上のお客様はテクニカルサポートにてご質問を承らせて頂きます。

推奨画面サイズ1024×768px以上

ページの先頭へ