代表 FCM 舊版 API 通知訊息酬載的介面。通知訊息可讓開發人員傳送多達 4 KB 的預先定義鍵/值組合。以下列出可接受的金鑰。
如需程式碼範例和詳細說明文件，請參閱「建構傳送要求」。
簽名：
export interface NotificationMessagePayload
屬性
| 屬性 | 類型 | 說明 |
|---|---|---|
| 徽章 | 字串 | 徽章在主畫面應用程式圖示上的值。如未指定，徽章不會變更。如果設為「0」，徽章就會移除。**平台：** iOS |
| 內文 | 字串 | 通知的內文。**平台：** iOS、Android、網頁 |
| bodyLocArgs | 字串 | 用於取代 body_loc_key 中的格式指定碼，用來將內文本地化至使用者目前的本地化。這個值應為字串化的 JSON 陣列。**iOS：** iOS 酬載與 loc-args 對應。詳情請參閱酬載金鑰參考資料和本地化遠端通知內容。**Android** 詳情請參閱格式設定與樣式。**平台：** iOS、Android |
| bodyLocKey | 字串 | 應用程式字串資源中的內文字串鍵，用來根據使用者目前的本地化設定本地化內文。**iOS：** 對應至 APN 酬載中的 loc-key。詳情請參閱酬載金鑰參考資料和本地化遠端通知內容。**Android** 詳情請參閱字串資源。**平台：** iOS、Android |
| 點擊動作 | 字串 | 與使用者點擊通知相關的動作。如果有指定，系統就會在使用者點擊通知時啟動包含相符意圖篩選器的活動。***平台：** Android |
| 顏色 | 字串 | 通知圖示的顏色，以 #rrggbb 格式表示。**平台：** Android |
| 圖示 | 字串 | 通知的圖示。**Android：** 將可繪製資源 myicon 的通知圖示設為 myicon。如果您沒有透過要求傳送這個金鑰，FCM 會顯示應用程式資訊清單中指定的啟動器圖示。**網路：** 要用於通知圖示的網址。**平台：** Android、網站 |
| 音效 | 字串 | 裝置收到通知時要播放的音效。支援「default」，或應用程式隨附的音效資源檔案名稱。音效檔案必須位於/res/raw/。**平台：** Android |
| 代碼 | 字串 | 用來取代通知導覽匣中現有通知的 ID。如未指定，每個要求都會建立新通知。如果指定此 ID，且已顯示含有相同標記的通知，新通知會取代通知導覽匣中的現有通知。**平台：** Android |
| title | 字串 | 通知的標題。**平台：** iOS、Android、網頁 |
| titleLocArgs | 字串 | 用來取代 title_loc_key 中的格式指定碼，用於根據使用者目前的本地化設定將標題文字本地化。值應為字串化的 JSON 陣列。**iOS：** 與 APN 酬載中的 title-loc-args 對應。詳情請參閱酬載金鑰參考資料和本地化遠端通知內容。**Android** 詳情請參閱格式設定與樣式。**平台：** iOS、Android |
| titleLocKey | 字串 | 應用程式字串資源中標題字串的鍵，用來將標題文字本地化，為使用者目前的本地化內容。**iOS：** 對應至 APN 酬載中的 title-loc-key。詳情請參閱酬載金鑰參考資料和本地化遠端通知內容。**Android** 詳情請參閱字串資源。**平台：** iOS、Android |
通知 MessagePayload.badge
主畫面應用程式圖示上的徽章值。
若未指定，則不會變更徽章。
如果設為 0，系統就會移除徽章。
**平台：** iOS
簽名：
badge?: string;
NotificationMessagePayload.body
通知的內文。
**平台：** iOS、Android、網頁
簽名：
body?: string;
NotificationMessagePayload.bodyLocArgs
用來取代 body_loc_key 中的格式指定碼的變數字串值，用來將內文本地化到使用者目前的本地化。
此值應為字串化的 JSON 陣列。
**iOS：** 對應 APN 酬載中的 loc-args。詳情請參閱酬載金鑰參考資料和將遠端通知內容本地化。
**Android：** 詳情請參閱格式和樣式。
**平台：** iOS、Android
簽名：
bodyLocArgs?: string;
NotificationMessagePayload.bodyLocKey
應用程式字串資源中的主體字串鍵，用來將內文文字本地化至使用者目前的本地化。
**iOS：** 對應 APN 酬載中的 loc-key。詳情請參閱酬載金鑰參考資料和將遠端通知內容本地化。
**Android：** 詳情請參閱字串資源。
**平台：** iOS、Android
簽名：
bodyLocKey?: string;
NotificationMessagePayload.clickAction
與使用者點擊通知相關的動作。如果有指定，系統就會在使用者點擊通知時啟動包含相符意圖篩選器的活動。
* **平台：** Android
簽名：
clickAction?: string;
NotificationMessagePayload.color
通知圖示的顏色，以 #rrggbb 格式表示。
**平台：** Android
簽名：
color?: string;
NotificationMessagePayload.圖示
通知圖示。
**Android：** 將可繪製資源 myicon 的通知圖示設為 myicon。如果您沒有在要求中傳送這個金鑰，FCM 會顯示應用程式資訊清單中指定的啟動器圖示。
**網頁：** 通知圖示所使用的網址。
**平台：** Android、網頁
簽名：
icon?: string;
通知 MessagePayload.sound
裝置收到通知時要播放的音效。支援「default」，或應用程式隨附的音效資源檔案名稱。音效檔案必須位於/res/raw/中。
**平台：** Android
簽名：
sound?: string;
NotificationMessagePayload.tag
用於取代通知導覽匣中現有通知的 ID。
如未指定，每個要求都會建立新通知。
如果已指定，且已顯示含有相同標記的通知，新通知會取代通知導覽匣中的現有通知。
**平台：** Android
簽名：
tag?: string;
NotificationMessagePayload.title
通知的標題。
**平台：** iOS、Android、網頁
簽名：
title?: string;
NotificationMessagePayload.titleLocArgs
用來取代 title_loc_key 中的格式指定碼的變數字串值，用來將標題文字本地化至使用者目前的本地化。
此值應為字串化的 JSON 陣列。
**iOS：** 對應 APN 酬載中的 title-loc-args。詳情請參閱酬載金鑰參考資料和將遠端通知內容本地化。
**Android：** 詳情請參閱格式和樣式。
**平台：** iOS、Android
簽名：
titleLocArgs?: string;
NotificationMessagePayload.titleLocKey
應用程式字串資源中標題字串的鍵，用來將標題文字本地化，為使用者目前的本地化內容。
**iOS：** 對應 APN 酬載中的 title-loc-key。詳情請參閱酬載金鑰參考資料和將遠端通知內容本地化。
**Android：** 詳情請參閱字串資源。
**平台：** iOS、Android
簽名：
titleLocKey?: string;