ページの先頭行へ戻る
Interstage Mobile Application Server V1.2.0 アプリケーション開発ガイド
FUJITSU Software

7.6.1 共通メッセージ送信アプリケーションの開発

共通メッセージ送信APIを利用することで、各プッシュサービスへ共通のメッセージを送信できます。

各プッシュサービスのメッセージのオプションは、テンプレートファイル、またはリクエストのボディのmessageOptionsで指定できます。各指定方法の利用例を以下に示します。

指定方法

利用例

テンプレートファイル

・定型文をメッセージで送信する場合(例:開始時間10分前を通知するメッセージを送る場合)

・毎回、同じオプションを指定する場合(例:通知バーに表示するメッセージ(ticker)が同じ場合)

messageOptions

・メッセージ毎にオプションを変更したい場合(例:メッセージの有効期限がメッセージ毎に異なる場合)

・テンプレートファイルのオプションを追加・変更したい場合(例:actionのURL指定を追加したい場合)

テンプレートファイル、およびmessageOptionsで指定可能なメッセージのオプションの一覧を以下に示します。

定義名

対応する各プッシュサービスのオプション

意味・用途

対象(プッシュ種別)

IMAPS

APNs

GCM

message

message(IMAPS)、body(APNs)、message(GCM)

通知するメッセージ情報

※テンプレートファイルのみ指定可能。リクエストのボディのmessageで指定するため、messageOptionsでは指定不可。

String

fjp_title

title

通知領域に表示するタイトル

String

fjp_ticker

ticker

通知バーに表示するメッセージ

String

fjp_message_arg

message_arg

メッセージに渡す引数

String

fjp_action

action

通知するメッセージ情報

String

fjp_sound

sound

通知音

String

fjp_led_color

led_color

イルミネーション色

String

fjp_led_pattern

led_pattern

イルミネーションパターン

String

fjp_vib

vib

バイブレーション

String

apns_expiration

expiration(header)

APNsストレージに保持されるメッセージの期間

int

apns_loc-key

loc-key

通知センターに表示するメッセージ(messageより優先される)

String

apns_loc-args

loc-args

loc-keyに渡す引数(複数ある場合、カンマ区切りで指定)

String

apns_launch-image

launch-image

起動画面

String

apns_action-loc-key

action-loc-key

ボタンのローカライズ文字列

String

apns_badge

badge

バッジ

int

apns_sound

sound

通知音

String

apns_category

category

カテゴリ指定

String

apns_action

action

通知領域のタップ時のアクション

String

apns_content-available

content-available

バックグラウンドのアプリケーションダウンロード設定

int

gcm_collapse_key

collapse_key

グループでの折畳み

String

gcm_delay_while_idle

delay_while_idle

デバイスのアクティブ確認後に送信

boolean

gcm_time_to_live

time_to_live

GCMストレージに保持されるメッセージの期間

int

gcm_restricted_package_name

restricted_package_name

クライアントアプリケーションのパッケージ名でメッセージ送信を制限

String

gcm_dry_run

dry_run

メッセージ送信しない(デバッグ用)

boolean

gcm_title

title

通知領域に表示するタイトル

String

gcm_ticker

ticker

通知バーに表示するメッセージ

String

gcm_message_arg

message_arg

メッセージに渡す引数

String

gcm_action

action

通知領域のタップ時のアクション

String

gcm_sound

sound

通知音

String

gcm_led_color

led_color

イルミネーション色

String

gcm_led_pattern

led_pattern

イルミネーションパターン

String

gcm_vib

vib

バイブレーション

String

注意

  • テンプレートファイル、およびmessageOptionsで指定する値は、クライアントアプリケーションにバンドルしたリソースに、前もって定義が必要なものがあります。詳細は、7.2 受信したメッセージの表示の各プッシュのPayload仕様を参照してください。
  • リクエストボディのmessageとテンプレートファイルのmessage両方が指定された場合は、リクエストボディのmessageに設定したものが優先されます。
  • テンプレートファイルとmessageOptionsの両方に値が設定されている場合は、messageOptionsの値が優先されます。