カスタムペイロードとは

プッシュ通知に乗せて、JSON形式で様々な情報をアプリに送ることができる機能がカスタムペイロードです。
具体的には、プッシュ通知を受け取ってそのプッシュ通知に載っていたカスタムペイロードを、アプリで読み取りアプリ側でカスタムペイロードに応じて画面の色を変更するなどができます。
null

カスタムペイロードのアプリ側でのハンドリング方法は以下を参照してください。
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を直接記述する以外に「入力フォームを設定」し、フォームで値を追加することもできます。

null

入力フォームを設定する

以下のようなデータを「入力フォーム設定」に記載することでカスタムペイロードをフォームで入力することが可能になります。

入力フォームで設定していた値は、未設定でもバリデーションされません。また、入力フォームで設定した以外の値もJSONデータの直接入力側で追加することができます。あくまで、JSONデータのいずれかの値を入力するサポートをするための機能となります。

null

{
  "text": {
    "type": "text"
  },
  "iconColorCode": {
    "type": "color"
  },
  "startDate": {
    "type": "date"
  },
  "endDate": {
    "type": "date"
  },
  "brandName": {
    "type": "select",
    "option": [
      {
        "label": "ほげ",
        "value": "hoge"
      },
      {
        "label": "ふが",
        "value": "fuga"
      }
    ]
  }
}

textフィールド

null

入力フォーム設定

"key_name": {
  "type": "text"
}

出力されるJSONデータ

{
  "key_name": "テスト"
}

colorpickerフィールド

null

入力フォーム設定

"key_name": {
  "type": "color"
}

出力されるJSONデータ

{
  "key_name": "#733232"
}

dateフィールド

null

入力フォーム設定

"key_name": {
  "type": "date"
}

出力されるJSONデータ

{
  "key_name": "2024-03-06"
}

selectフィールド

null

入力フォーム設定

"key_name": {
  "type": "select",
  "option": [
    {
      "label": "ほげ",
      "value": "hoge"
    },
    {
      "label": "ふが",
      "value": "fuga"
    }
  ]
}

出力されるJSONデータ

{
  "key_name": "hoge"
}

注意点

  • 入力フォームの「設定名」が被ると先に書かれている入力フォームが削除されてしまいます。名前が被らないように入力フォーム名を記載してください。