FANSHIPが、APNs, FCMへと送るペイロードの仕様について
互換性保証について
PUSH通知ペイロードは、機能追加などのケースにおいて、予告なく変更する可能性がございます。
変更時に、お客様への事前告知を行う場合の条件は、以下となりますので、アプリ側プログラムで利用される場合、ご留意ください。
- 「互換性保証」がある各項目に関して、キー自体が無くなる場合
- 「互換性保証」がある各項目に関して、キーに対する値が変更される場合
互換性保証がないキー（およびその値）に対して、それを前提としたプログラムを実装しないでください。
免責事項
APNs ペイロードは、Apple社のサーバーを通過し、iOSによりアプリのコードに通知されます。
そのため、Apple社の仕様変更により、互換性を維持できない可能性がございますが、弊社の責任範囲を超えるものとします。
また、Apple社の仕様変更を起因とし、PUSH通知ペイロードの非互換な仕様変更を行わざるを得ない場合においても、それを事前通知する義務を負わないものとします。
iOS
{
"aps": {
"alert": {
"loc-key" : "ポップアップ文言",
"title": "ポップアップタイトル"
},
"badge": 1,
"sound": "default",
"mutable-content": 1,
"thread-id": "thread-sample"
},
"mid" : 123,
"category": "popinfoNotificationCategory",
"push-provider": "popinfo",
"icon": "https://example.com/example.png",
"url": "https://example.com/example.html",
"has_detail": true,
"popinfo_category": "category_sample",
"_custom_key": "custom_value"
}
| パラメータ |
デフォルト※ |
型 |
互換性保証 |
説明 |
| .aps |
O |
Object |
- |
Appleの公式仕様にて利用されている項目 |
| .aps.alert |
O |
Object |
- |
|
| .aps.alert.loc-key |
O |
文字列 |
O |
|
| .aps.alert.title |
X |
文字列 |
X |
|
| .aps.badge |
O |
数値 |
X |
|
| .aps.sound |
O |
文字列 |
X |
|
| .aps.mutable-content |
O |
数値 |
X |
|
| .aps.thread-id |
X |
文字列 |
X |
|
| .mid |
O |
数値 |
O |
|
| .category |
O |
文字列 |
O |
固定文言(popinfoNotificationCategory) |
| .push-provider |
O |
文字列 |
O |
"popinfo"から始まる文字列 |
| .icon |
O |
文字列 |
O |
|
| .url |
O |
文字列 |
O |
|
| .has_detail |
O |
bool |
O |
プッシュ配信に対応するお知らせ詳細が存在するか否か。プッシュのみ配信かどうかの判定に使う |
| .popinfo_category |
O |
文字列 |
O |
プッシュ配信で登録するcategoryパラメータの値 |
| _[custom_key] |
X |
任意 |
X |
ユーザが任意で設定できるキーバリュー |
※全てのプッシュ通知において、デフォルト設定でペイロードにそのキーが存在するか否か。
Xになっているキーは高度な配信設定を行うことで、設定できる項目。
Android
{
"data": {
"message": "ポップアップ文言",
"id": "message_id",
"icon": "icon",
"link_url": "https://...",
"push-provider": "popinfo",
"has_detail": true,
"category": "category_sample",
"_custom_key": "custom_value"
},
"collapse_key": "popinfoiridge",
"dry_run": false
}
| パラメータ |
デフォルト※ |
型 |
互換性保証 |
説明 |
| .data |
O |
Object |
- |
|
| .data.message |
O |
文字列 |
O |
|
| .data.id |
O |
文字列 |
O |
数字の文字列型 |
| .data.icon |
O |
文字列 |
O |
|
| .data.link_url |
O |
文字列 |
O |
|
| .data.has_detail |
O |
bool値 |
O |
|
| .data.push-provider |
O |
文字列 |
O |
"popinfo"から始まる文字列 |
| .collapse_key |
X |
文字列 |
X |
固定文言(popinfoiridge) |
| .dry_run |
O |
bool値 |
X |
|
| .category |
O |
文字列 |
O |
プッシュ配信で登録するcategoryパラメータの値 |
| _[custom_key] |
X |
任意 |
X |
ユーザが任意で設定できるキーバリュー |
※全てのプッシュ通知において、デフォルト設定でペイロードにそのキーが存在するか否か。
Xになっているキーは高度な配信設定を行うことで、設定できる項目。
