カスタムペイロードとは
プッシュ通知に乗せて、JSON形式で様々な情報をアプリに送ることができる機能がカスタムペイロードです。
具体的には、プッシュ通知を受け取ってそのプッシュ通知に載っていたカスタムペイロードを、アプリで読み取りアプリ側でカスタムペイロードに応じて画面の色を変更するなどができます。
カスタムペイロードのアプリ側でのハンドリング方法は以下を参照してください。
https://developers.karte.io/docs/app-customize-notification-payload#%E8%A8%AD%E5%AE%9A%E3%81%97%E3%81%9F%E5%80%A4%E3%81%AE%E5%8F%82%E7%85%A7%E6%96%B9%E6%B3%95
Messageでのカスタムペイロード設定
KARTE Messageではカスタムペイロードの設定方法を二通り提供しています。
JSONを直接記載する
カスタムペイロードとして送信したい値をJSONでそのまま記述することができます。
スキーマを設定してUIで記載する
以下のようなJSONをスキーマに記載することでカスタムペイロードをGUIで変更することが可能になります。
{
"text": {
"type": "text"
},
"iconColorCode": {
"type": "color"
},
"startDate": {
"type": "date"
},
"endDate": {
"type": "date"
},
"brandName": {
"type": "select",
"option": [
{
"label": "ほげ",
"value": "hoge"
},
{
"label": "ふが",
"value": "fuga"
}
]
}
}
textフィールド
設定するスキーマJSON
"key_name": {
"type": "text"
}
出力されるJSON
{
"key_name": "テスト"
}
colorpickerフィールド
設定するスキーマJSON
"key_name": {
"type": "color"
}
出力されるJSON
{
"key_name": "#733232"
}
dateフィールド
設定するスキーマJSON
"key_name": {
"type": "date"
}
出力されるJSON
{
"key_name": "2024-03-06"
}
selectフィールド
設定するスキーマJSON
"key_name": {
"type": "select",
"option": [
{
"label": "ほげ",
"value": "hoge"
},
{
"label": "ふが",
"value": "fuga"
}
]
}
出力されるJSON
{
"key_name": "hoge"
}
注意点
- スキーマの名前が被ると先に書かれているスキーマが削除されます。名前が被らないようにスキーマ名を記載してください。