このたび、カスタム(JSON)形式を選択したプッシュ通知の作成・編集画面で、一部UIの変更を行います。
それに伴い、プッシュ通知・イベント起点プッシュ通知でカスタムペイロード(Android向け)に入力できる内容が一部制限されます。
基本的にお客様でご対応いただく必要はありませんが、過去配信したキャンペーンの表示やそのキャンペーン複製時の挙動に影響があります。
リリース日
2024 年 1 月 22 日 予定
対応内容
プッシュ通知をカスタム(JSON)形式で作成する場合、カスタムペイロードという1つの入力フォームで記載する必要がありました。
本リリースにより、iOS向けとAndroid向けの内容を分けて入力できるようになります。
カスタムペイロード(Android)のみ、データの形式に制限が設けられます。詳しくは本リリースで変わることで説明します。
UIの変更点
リリース前
リリース後
対応の背景
2023年10月23日に FCM HTTP v1 API の対応をリリースしました。
Repro App 機能アップデート | Androidへのプッシュ通知で FCM HTTP v1 API に対応しました
これに伴い、Android端末向けの配信に利用する data キーの中に、数値・オブジェクトが含まれても、文字列のみを含むペイロードへ変換して配信する必要がありました。
現在は、自動で文字列のみのペイロードへ自動で変換処理が行われています。
カスタム(JSON)のAndroid向けプッシュ通知でペイロードを一部自動変換し配信するようになります
今回の変更により、期待される data キーの中に文字列のみを含むペイロードのみを登録できるようにします。
過去のキャンペーンにおける自動移行
本リリース以前に作成したカスタム(JSON)形式のキャンペーンは、自動的に移行されます。
具体的には、過去にカスタムペイロードとして登録された内容が、カスタムペイロード(iOS向け)、ならびにカスタムペイロード(Android向け)、どちらにも表示される状態となります。
これまで、1つのカスタムペイロードとして指定された内容を、iOS端末とAndroid端末どちらにも送信していました。今回の変更により、iOS向けとAndroid向けどちらにも同じ内容が複製された状態で配信しても問題は発生しません。
本リリースで変わること
カスタムペイロード(Android向け)の登録時、data キーの中身には、数値・オブジェクトを含めることができません。
文字列のみを指定する必要があります。
この制限は本リリース以降、イベント起点プッシュ通知にも同様に適用されます。
利用できないペイロード形式
{
"data": {
"name": "Alice",
"age": 30,
"isStudent": false,
"address": {
"street": "123 Main St",
"city": "Wonderland"
}
}
}
今後も利用できるペイロード形式
{
"data": {
"name": "Alice",
"age": "30",
"isStudent": "false",
"address": "{\"street\":\"123 Main St\",\"city\":\"Wonderland\"}"
}
}
利用できないペイロード形式を、利用できるペイロード形式へ変換を行っても、アプリへの通知影響はありません。
参考:カスタム(JSON)のAndroid向けプッシュ通知でペイロードを一部自動変換し配信するようになります
また、自動移行のとき、利用できないペイロード形式で data キーが登録されていた場合、文字列に変換した上で登録します。
お客様に対応いただくこと
今後キャンペーンを作成するとき、以下の点にご留意ください。
キャンペーンを複製する場合
過去のプッシュ通知キャンペーンを複製するとき、iOS向け、Android向けに同一のペイロードが自動的に登録されます。
OSごとにペイロードを分けて配信したい場合は、内容を見直してください。
修正しない場合でも、配信される通知に影響はありません。
キャンペーンを新規作成する場合
過去に使用していたペイロード形式では、登録できない可能性があります。
Android向けにdataキーを使用する場合、その中身は文字列のみを指定する必要があります。
今後も利用できるペイロード形式を参照し、内容を見直してください。
よくある質問
Q.新しいUIで正しくペイロードが登録できているか不安です。確認してもらえますか?
恐れ入りますが、弊社担当ではお答えできません。
プッシュ通知のカスタム(JSON)形式は、アプリの実装によりキーが異なるものですので、実装担当のエンジニア様にご確認ください。
Q.iOS向けのみ、Android向けのみのプッシュ通知は配信できますか?
アプリ実装によっては実現できます。
配信しないOS向けのペイロードに {}
のみを指定することで、プッシュ通知の配信処理が発生しても、アプリ側で表示させないプッシュ通知として実現します。(この場合、配信数には計上されます)
本アップデートに関するお問い合わせ
カスタマーサクセス担当、もしくは管理画面のチャットよりお問い合わせください。
今後も安定したサービスを提供するため、機能の改善を行っていきますので引き続きReproをよろしくお願いします。