プッシュ部品で受信したメッセージを通知バーに表示します。(android.app.Notification) IMAPSプッシュのメッセージ表示と同様の表示になります。
Payloadのフォーマット
PayloadはJSON形式で指定します。
Payload仕様
Payloadでサポートするタグ情報は以下のとおりです。
タグ | 意味 | 概要 | ||
data | Gcmの固定Payloadのタグ | |||
title | 通知領域に表示するタイトル部 | 任意 | 指定しない場合、push.NotificationAppNameで示されたリソースの定義値を表示する。 指定する場合は、アプリにバンドルしたリソースの定義値とする。 指定された定義値がアプリ内にみつからない場合は、指定内容をそのまま表示する。空文字の場合は空文字が表示される。 | |
ticker | 通知バーに表示するメッセージ部 | 任意 | 指定しない場合、プッシュクライアントが保持しているティッカー定義文(※)を表示する。 指定する場合は、アプリにバンドルしたリソースの定義値とする。 指定された定義値がアプリ内にみつからない場合は、指定内容をそのまま表示する。空文字の場合は空文字が表示される。 | |
message | 通知領域に表示するメッセージ部 | 必須 | 指定しない場合や空文字を指定した場合は、通知バーに表示されない。 指定する場合は、アプリにバンドルしたリソースの定義値とする。 指定された定義値がアプリ内にみつからない場合は、指定内容をそのまま表示する。 | |
message_arg | メッセージに渡す引数 | 任意 | messageに%sを指定した場合に、書式指定子の代わりに表示する変数文字列値を指定する。messageに書式指定子があり、message_argを省略した場合は、書式指定子がそのままメッセージ部に表示される。空文字を指定した場合は、空文字に置き換わる。 | |
action | 通知領域のタップ時のアクション | 任意 | 指定しない場合、通知領域のタップ時に、通知を消去する。指定した場合、かつ、push.NotificationMainClassNameに有効値が指定されている場合は、通知を消去し、指定されたアクションを行う。 | |
sound | 通知音 | 任意 | 指定しない場合、かつ、push.RingtoneUriに有効値が指定されていない場合は、音を再生しない。 指定する場合は、TYPE_ALARM／TYPE_NOTIFICATION／TYPE_RINGTONEのいずれかを指定するが、3種以外が指定されていた場合は、端末の通知音（TYPE_NOTIFICATION）を再生する いずれの場合も、繰り返しは行わず1度だけ再生する。また、マナーモード時は再生しない。 | |
led_color | イルミネーション色 | 任意 | 指定しない場合、または定義値が無い場合は、イルミネーションは発光しない。 指定する場合は、アプリにバンドルしたリソースの定義値とする。 リソースにてARGB(ffff0000など)を定義する。 ただし、実際の発光については、端末に依存する。 | |
led_pattern | イルミネーションパターン | 任意 | 指定しない場合、または定義値が無い場合は、イルミネーションは発光しない。 指定する場合は、アプリにバンドルしたリソースの定義値とする。 リソースにてパターンを定義する。（OnTime,OffTimeの順） ただし、実際の発光については、端末に依存する。 | |
vib | バイブレーション | 任意 | 指定しない、または定義値が無い場合は、振動しない。 指定する場合は、アプリにバンドルしたリソースの定義値とする。 | |
registration_ids | registrationID | 任意 | 空にするか、または指定しない | |
※ティッカー定義文：（日本語）「メッセージを受信しました。」 （英語）「Received the Message.」
その他のGCM固有のタグについては、GCMの公式サイトを確認してください。
