プッシュメッセージのカスタマイズ

プッシュメッセージを送信する際、FCM では制御用フィールドを使ってプッシュ通知の詳細動作をカスタマイズすることができます。

Kii Cloud でプッシュメッセージを送信する際は、ユーザープッシュ通知 (Push to User)管理者メッセージのプッシュ通知(Direct Push) で、ここに示す制御用フィールドを設定できます。サーバー上変更のプッシュ通知(Push to App) では Kii Cloud でのデフォルトの設定が使用され、設定できません。

FCM のメッセージカスタマイズ

FCM の通知メッセージに含まれるデータのうち、特に重要なものを以下に示します。これらの詳細な解説や、その他のタグは 公式ドキュメント をご覧ください。

下記の制御用フィールド以外にも、プッシュメッセージの内部にモバイルアプリで使用するカスタムデータを含めることができます。FCM では、プッシュメッセージのペイロード全体で 4096 バイトしかサポートしないため、カスタムデータを設計する際には上限サイズを超えないようにご注意ください。

Collapse key

collapse_key キーによって、デバイスがアイドル状態にあるときに、同じ重複キーを持ったメッセージを 1 つにまとめて配信できます。指定がない場合はすべてのメッセージが配信されます。

Restricted package name

restricted_package_name キーを指定すると、指定したパッケージ名を持つモバイルアプリ以外では、プッシュメッセージを受け取れなくなります。

Time to live

time_to_live キーによって、デバイスが FCM に接続されていない場合に FCM サーバーがメッセージを破棄するまでの時間を秒単位で指定できます。指定がない場合、FCM によってデフォルトの 4 週間が使用されます。

time_to_live を指定する場合、collapse_key も指定しないとエラーになります。

Delay while idle

delay_while_idle キーによって、デバイスがアイドル状態にあるときでもメッセージを配信するかどうかを指定します。true に設定されているときにデバイスがスリープ状態にあると、そのメッセージはデバイスがアクティブになるまで配信されません。

すぐに配信されない場合、collapse_key による重複メッセージの削除が有効になります。