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

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

指定方法	利用例
テンプレートファイル	定型文をメッセージで送信する場合(例：開始時間10分前を通知するメッセージを送る場合) 毎回、同じオプションを指定する場合(例：通知バーに表示するメッセージ(ticker)が同じ場合)
messageOptions	メッセージ毎にオプションを変更したい場合(例：メッセージの有効期限がメッセージ毎に異なる場合) テンプレートファイルのオプションを追加・変更したい場合(例：actionのURL指定を追加したい場合)

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

定義名			対応する各プッシュサービスのオプション	意味・用途	型	対象(プッシュ種別)
定義名			対応する各プッシュサービスのオプション	意味・用途	型	IMAPS	APNs	GCM	WNS
message			message(IMAPS)、body(APNs)、message(GCM) 、message(WNS)	通知するメッセージ情報 ※テンプレートファイルのみ指定可能。リクエストのボディの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	-	-	○	-
wns_toast_launch			toast要素の launch属性	トースト通知クリック時のアクション	String	-	-	-	○
wns_toast_duration			toast要素のduration属性	トースト通知の表示時間	String	-	-	-	○
wns_toast_visual_version			toast-visual要素のversion属性	トースト通知のXMLスキーマのバージョン	integer	-	-	-	○
wns_toast_visual_lang			toast-visual要素のlang属性	ロケール文字列	String	-	-	-	○
wns_toast_visual_addImageQuery			toast-visual要素のaddImageQuery属性	言語、倍率、コントラスト設定クエリパラメータの付与フラグ	boolean	-	-	-	○
wns_toast_visual_baseUri			toast-visual要素のbaseUri属性	ベースURI	anyURI	-	-	-	○
wns_toast_visual_branding			toast-visual要素のbranding属性	商標指定	String	-	-	-	○
wns_toast_visual_bindings	－		toast-visual-binding要素	binding要素で指定できるオプションをJSONオブジェクトの配列([{"template":"ToastText01","lang":"ja-JP"}]の型)で指定	array	-	-	-	○
	template		toast-visual-binding要素のtemplate属性	トースト通知のテンプレート	String	-	-	-	○
	fallback		toast-visual-binding要素のfallback属性	templateオプションで指定したテンプレートが存在しない場合に使用されるテンプレート	String	-	-	-	○
	lang		toast-visual-binding要素のlang属性	ロケール文字列	String	-	-	-	○
	addImageQuery		toast-visual-binding要素のaddImageQuery属性	言語、倍率、コントラスト設定クエリパラメーターの付与フラグ	boolean	-	-	-	○
	baseUri		toast-visual-binding要素のbaseUri属性	ベースURI	anyURI	-	-	-	○
	branding		toast-visual-binding要素のbranding属性	商標指定(未使用)	String	-	-	-	○
	images	－	toast-visual-binding-image要素	image要素で指定できるオプションをJSONオブジェクトの配列([{"src":"sample.jpg","addImageQuery":"true"}]の型)で指定	array	-	-	-	○
		src	toast-visual-binding-image要素のsrc属性	イメージのURL	String	-	-	-	○
		alt	toast-visual-binding-image要素のalt属性	イメージの説明	String	-	-	-	○
		addImageQuery	toast-visual-binding-image要素のaddImageQuery属性	言語、倍率、コントラスト設定クエリパラメータの付与フラグ	boolean	-	-	-	○
	texts	－	toast-visual-binding-text要素	text要素で指定できるオプションをJSONオブジェクトの配列([{"message":" message01","lang":"ja-JP"},{"message":"message02","lang":"ja-JP"}]の型)で指定	array	-	-	-	○
		message	toast-visual-binding-text要素のコンテンツ	メッセージ文字列	String	-	-	-	○
		lang	toast-visual-binding-text要素のlang属性	ロケール文字列	String	-	-	-	○
wns_toast_audio_src			toast-audio要素のsrc属性	トースト通知音	String	-	-	-	○
wns_toast_audio_loop			toast-audio要素のloop属性	トースト通知音をループするか否か	boolean	-	-	-	○
wns_toast_audio_silent			toast-audio要素のsilent属性	トースト通知音をサイレントにするか否か	boolean	-	-	-	○
wns_toast_commands_scenario			toast-commands要素のscenario属性	トースト通知の使用目的	String	-	-	-	○
wns_toast_commands_commands	－		toast-commands-command要素	command要素で指定できるオプションをJSONオブジェクトの配列([{"id":"snooze","arguments":"ABC"}]の型)で指定	array	-	-	-	○
	id		toast-commands-command要素のid属性	ユーザが実行できるアクション	String	-	-	-	○
	arguments		toast-commands-command要素のarguments属性	ユーザがアクションを実行した時に返される文字列	String	-	-	-	○
wns_badge_value			badge要素のvalue属性	バッジ通知で表示する情報	String	-	-	-	○
wns_badge_version			badge要素のversion属性	バッジ通知のXMLスキーマのバージョン	integer	-	-	-	○
wns_tile_visual_version			tile-visual要素のversion属性	タイル通知のXMLスキーマのバージョン	integer	-	-	-	○
wns_tile_visual_lang			tile-visual要素のlang属性	ロケール文字列	String	-	-	-	○
wns_tile_visual_addImageQuery			tile-visual要素のaddImageQuery属性	言語、倍率、コントラスト設定クエリパラメータの付与フラグ	boolean	-	-	-	○
wns_tile_visual_baseUri			tile-visual要素のbaseUri属性	ベースURI	anyURI	-	-	-	○
wns_tile_visual_branding			tile-visual要素のbranding属性	商標指定	String	-	-	-	○
wns_tile_visual_contentId			tile-visual要素のcontentId属性	通知のコンテンツを一意に識別するための送信者が定義する文字列	String	-	-	-	○
wns_tile_visual_bindings	－		tile-visual-binding要素	binding要素で指定できるオプションをJSONオブジェクトの配列([{"template":"TileSquareBlock","lang":"ja-JP"}]の型)で指定	array	-	-	-	○
	template		tile-visual-binding要素のtemplate属性	タイル通知テンプレート	String	-	-	-	○
	fallback		tile-visual-binding要素のfallback属性	templateオプションで指定したテンプレートが存在しない場合に使用されるテンプレート	String	-	-	-	○
	lang		tile-visual-binding要素のlang属性	ロケール文字列	String	-	-	-	○
	addImageQuery		tile-visual-binding要素のaddImageQuery属性	言語、倍率、コントラスト設定クエリパラメータの付与フラグ	boolean	-	-	-	○
	baseUri		tile-visual-binding要素のbaseUri属性	ベースURI	anyURI	-	-	-	○
	branding		tile-visual-binding要素のbranding属性	商標指定	String	-	-	-	○
	contentId		tile-visual-binding要素のcontentId属性	通知のコンテンツを一意に識別するための送信者側で定義する文字列	String	-	-	-	○
	images	－	tile-visual-binding-image要素	image要素で指定できるオプションをJSONオブジェクトの配列([{"src":"sample.jpg","addImageQuery":"true"}]の型)で指定	array	-	-	-	○
		src	tile-visual-binding-image要素のsrc属性	イメージのURL	String	-	-	-	○
		alt	tile-visual-binding-image要素のalt属性	イメージの説明	String	-	-	-	○
		addImageQuery	tile-visual-binding-image要素のaddImageQuery属性	言語、倍率、コントラスト設定クエリパラメータの付与フラグ	boolean	-	-	-	○
	texts	－	tile-visual-binding-text要素	text要素で指定できるオプションをJSONオブジェクトの配列([{"message":" message01","lang":"ja-JP"},{"message":"message02","lang":"ja-JP"}]の型)で指定	array	-	-	-	○
		message	tile-visual-binding-text要素のコンテンツ	メッセージ文字列	String	-	-	-	○
		lang	tile-visual-binding-text要素のlang属性	ロケール文字列	String	-	-	-	○
wns_badge_tile_only			無し	true：トースト通知を行わない、false：トースト通知を行う	boolean	-	-	-	○

注意

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

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