FCM レガシー API 通知メッセージ ペイロードを表すインターフェース。通知メッセージを使用すると、デベロッパーは事前定義された Key-Value ペアを最大 4 KB まで送信できます。使用できる鍵は以下のとおりです。
コードサンプルと詳細なドキュメントについては、送信リクエストを作成するをご覧ください。
署名:
export interface NotificationMessagePayload
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| バッジ | 文字列 | ホーム画面のアプリアイコンのバッジの値。指定しない場合、バッジは変更されません。0 に設定すると、バッジが削除されます。**プラットフォーム:** iOS |
| body | 文字列 | 通知の本文テキスト。**プラットフォーム:** iOS、Android、ウェブ |
| bodyLocArgs | 文字列 | ユーザーの現在のローカライズに合わせて本文テキストをローカライズするために使用する、body_loc_key の形式指定子の代わりに使用される変数文字列値。値は文字列化された JSON 配列である必要があります。**iOS:** APNs ペイロードの loc-args に対応します。詳細については、ペイロードキー リファレンスとリモート通知のコンテンツのローカライズをご覧ください。**Android:** 詳細については、フォーマットとスタイル設定をご覧ください。**プラットフォーム:** iOS、Android |
| bodyLocKey | 文字列 | ユーザーの現在のローカライズに合わせて本文テキストをローカライズするために使用する、アプリの文字列リソース内の本文文字列のキー。**iOS:** APNs ペイロードの loc-key に対応します。詳細については、ペイロードキー リファレンスとリモート通知のコンテンツのローカライズをご覧ください。**Android:** 詳細については、文字列リソースをご覧ください。**プラットフォーム:** iOS、Android |
| clickAction | 文字列 | 通知をクリックするユーザーに関連付けられたアクション。指定すると、ユーザーが通知をクリックしたときに、一致するインテント フィルタを持つアクティビティが起動されます。***プラットフォーム:** Android |
| 色 | 文字列 | 通知アイコンの色。#rrggbb 形式で表します。**プラットフォーム:** Android |
| アイコン | 文字列 | 通知のアイコン。**Android:** 通知アイコンをドローアブル リソース myicon の myicon に設定します。リクエストでこのキーを送信しない場合、FCM はアプリ マニフェストで指定したランチャー アイコンを表示します。**ウェブ:** 通知のアイコンに使用する URL。**プラットフォーム:** Android、ウェブ |
| サウンド | 文字列 | デバイスが通知を受信したときに再生される音です。「default」をサポートデバイスのデフォルトの通知音、またはアプリにバンドルされた音声リソースのファイル名です。サウンド ファイルは /res/raw/ に存在する必要があります。**プラットフォーム:** Android |
| タグ | 文字列 | 通知ドロワー内の既存の通知を置き換えるために使用される識別子。指定しない場合、リクエストごとに新しい通知が作成されます。指定した場合、同じタグを持つ通知がすでに表示されている場合は、通知ドロワーの既存の通知が新しい通知に置き換えられます。**プラットフォーム:** Android |
| title | 文字列 | 通知のタイトル。**プラットフォーム:** iOS、Android、ウェブ |
| titleLocArgs | 文字列 | ユーザーの現在のローカライズに合わせてタイトル テキストをローカライズするために使用する、title_loc_key の形式指定子の代わりに使用される変数文字列値。値は文字列化された JSON 配列である必要があります。**iOS:** APNs ペイロードの title-loc-args に対応します。詳細については、ペイロードキー リファレンスとリモート通知のコンテンツのローカライズをご覧ください。**Android:** 詳細については、フォーマットとスタイル設定をご覧ください。**プラットフォーム:** iOS、Android |
| titleLocKey | 文字列 | ユーザーの現在のローカライズに合わせてタイトル テキストをローカライズするために使用する、アプリの文字列リソース内のタイトル文字列のキー。**iOS:** APNs ペイロードの title-loc-key に対応します。詳細については、ペイロードキー リファレンスとリモート通知のコンテンツのローカライズをご覧ください。**Android:** 詳細については、文字列リソースをご覧ください。**プラットフォーム:** iOS、Android |
NotificationMessagePayload.badge
ホーム画面のアプリアイコンのバッジの値。
指定しない場合、バッジは変更されません。
0 に設定すると、バッジは削除されます。
**プラットフォーム:** iOS
署名:
badge?: string;
NotificationMessagePayload.body
通知の本文。
**プラットフォーム:** iOS、Android、ウェブ
署名:
body?: string;
NotificationMessagePayload.bodyLocArgs
ユーザーの現在のローカライズに合わせて本文テキストをローカライズするために使用する、body_loc_key の形式指定子の代わりに使用される変数文字列値。
値は文字列化された JSON 配列にする必要があります。
**iOS:** APNs ペイロードの loc-args に対応します。詳細については、ペイロード キー リファレンスとリモート通知のコンテンツのローカライズをご覧ください。
**Android:** 詳しくは、書式設定とスタイル設定をご覧ください。
**プラットフォーム:** iOS、Android
署名:
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
ユーザーの現在のローカライズに合わせて本文テキストをローカライズするために使用する、アプリの文字列リソース内の本文文字列のキー。
**iOS:** APNs ペイロードの loc-key に対応します。詳細については、ペイロード キー リファレンスとリモート通知のコンテンツのローカライズをご覧ください。
**Android:** 詳しくは、文字列リソースをご覧ください。
**プラットフォーム:** iOS、Android
署名:
bodyLocKey?: string;
NotificationMessagePayload.clickAction
通知をクリックするユーザーに関連付けられたアクション。指定すると、ユーザーが通知をクリックしたときに、一致するインテント フィルタを持つアクティビティが起動されます。
* **プラットフォーム:** Android
署名:
clickAction?: string;
NotificationMessagePayload.color
通知アイコンの色。#rrggbb 形式で表します。
**プラットフォーム:** Android
署名:
color?: string;
NotificationMessagePayload.icon
通知のアイコン。
**Android:** ドローアブル リソース myicon の通知アイコンを myicon に設定します。リクエストでこのキーを送信しない場合、FCM はアプリ マニフェストで指定したランチャー アイコンを表示します。
**ウェブ:** 通知のアイコンに使用する URL。
**プラットフォーム:** Android、ウェブ
署名:
icon?: string;
NotificationMessagePayload.sound
デバイスが通知を受信したときに再生される音です。「default」をサポートデバイスのデフォルトの通知音、またはアプリにバンドルされた音声リソースのファイル名です。サウンド ファイルは /res/raw/ に存在する必要があります。
**プラットフォーム:** Android
署名:
sound?: string;
NotificationMessagePayload.tag
通知ドロワー内の既存の通知を置き換えるために使用される識別子。
指定しない場合、リクエストごとに新しい通知が作成されます。
指定した場合、同じタグを持つ通知がすでに表示されている場合は、新しい通知によって通知ドロワーの既存の通知が置き換えられます。
**プラットフォーム:** Android
署名:
tag?: string;
NotificationMessagePayload.title
通知のタイトル。
**プラットフォーム:** iOS、Android、ウェブ
署名:
title?: string;
NotificationMessagePayload.titleLocArgs
ユーザーの現在のローカライズに合わせてタイトル テキストをローカライズするために使用する、title_loc_key の形式指定子の代わりに使用される可変文字列値。
値は文字列化された JSON 配列にする必要があります。
**iOS:** APNs ペイロードの title-loc-args に対応します。詳細については、ペイロード キー リファレンスとリモート通知のコンテンツのローカライズをご覧ください。
**Android:** 詳しくは、書式設定とスタイル設定をご覧ください。
**プラットフォーム:** iOS、Android
署名:
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
ユーザーの現在のローカライズに合わせてタイトル テキストをローカライズするために使用する、アプリの文字列リソース内のタイトル文字列のキー。
**iOS:** APNs ペイロードの title-loc-key に対応します。詳細については、ペイロード キー リファレンスとリモート通知のコンテンツのローカライズをご覧ください。
**Android:** 詳しくは、文字列リソースをご覧ください。
**プラットフォーム:** iOS、Android
署名:
titleLocKey?: string;