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