Firebase 雲端通訊 HTTP 通訊協定

這個參數可指定訊息的收件者。

這個值可以是裝置的註冊權杖、裝置群組的通知鍵或單一主題 (前置字串為 /topics/)。如要傳送至多個主題，請使用 condition 參數。

這個參數會指定多點傳播訊息的接收者，即傳送至多個註冊權杖的訊息。

值應為要傳送多點傳播訊息的註冊權杖陣列。陣列必須包含 1 至 1,000 個註冊權杖。如要將訊息傳送至單一裝置，請使用 to 參數。

多點傳播訊息只能使用 HTTP JSON 格式。

這個參數會指定條件的邏輯運算式，以決定訊息目標。

支援條件：主題，格式為「yourTopics in topics」。這個值不區分大小寫。

支援的運算子：&&、||。每個主題訊息最多支援兩個運算子。

此參數已淘汰。請改用 to 指定郵件收件者。如要進一步瞭解如何將訊息傳送至多部裝置，請參閱所用平台的說明文件。

此參數可識別可收合的一組訊息 (例如使用 collapse_key: "Updates Available")，因此在恢復傳送時，系統只會傳送最後一則訊息。這項功能是為了避免在裝置恢復連線或恢復使用時傳送過多相同訊息。

請注意，我們無法保證訊息的傳送順序。

注意：一次最多只能使用 4 個不同的收合鍵。也就是說，每個用戶端應用程式可同時儲存 4 則不同的訊息。如果超過這個數字，FCM 不一定會保留 4 個收合金鑰。

設定郵件的優先順序。有效值為「normal」和「高」。在 Apple 平台上，這些要求會對應至 APN 優先順序 5 和 10。

預設情況下，通知訊息會以高優先順序傳送，而資料訊息會以一般優先順序傳送。「一般優先順序」會最佳化用戶端應用程式的電池耗電量。除非需要立即提供功能，否則應使用這種優先順序。如果訊息的優先順序為一般，應用程式可能會收到未指定延遲時間的訊息。

如果訊息的優先順序較高，系統會立即傳送訊息，而且應用程式可以顯示通知。

在 Apple 平台上，請使用這個欄位代表 APN 酬載中的 content-available。當系統傳送通知或訊息並設為 true 時，系統會喚醒已停用的用戶端應用程式，並會以靜音通知形式透過 APN 傳送訊息，而不是透過 FCM。請注意，系統不保證能傳送 APN 的無聲通知，且可能取決於多項因素，例如使用者開啟低耗電模式、強制退出應用程式等。在 Android 上，資料訊息預設會喚醒應用程式。Chrome 目前不支援這項功能。

在 Apple 平台上，請使用這個欄位代表 APN 酬載中的 mutable-content。當通知發送且設為 true 時，您可以使用 通知服務應用程式額外資訊，在顯示通知前修改通知內容。Android 和網頁會忽略這個參數。

此參數用於指定裝置離線時，訊息應在 FCM 儲存空間保留的時間長度 (秒)。存留時間上限為 4 週，預設值為 4 週。詳情請參閱「設定訊息的效期」。

如果將這個參數設為 true，開發人員即可在不實際傳送訊息的情況下測試要求。

預設值為 false。

這個參數可指定訊息酬載的自訂鍵/值組合。

例如，使用 data:{"score":"3x1"}:

在 Apple 平台上，如果訊息是透過 APN 傳送，則代表自訂資料欄位。如果是透過 FCM 傳送，則會在 AppDelegate application:didReceiveRemoteNotification: 中以鍵/值字典表示。

在 Android 上，這會產生名為 score 的意圖額外意圖，且字串值為 3x1。

金鑰不得為保留字詞 (「from」、「message_type」)，或是任何以「google」或「gcm」開頭的字詞。請勿使用這個表格中定義的任何字詞，例如 collapse_key。

建議使用字串類型的值。您必須將物件或其他非字串資料類型 (例如整數或布林值) 中的值轉換為字串。

通知的標題。

手機和平板電腦不會顯示這個欄位。

通知的內文。

裝置收到通知時要播放的音效。

此字串用於指定用戶端應用程式主要套件，或應用程式資料容器的 Library/Sounds 資料夾中的音效檔案。詳情請參閱 iOS 開發人員資料庫。

主畫面應用程式圖示上的徽章值。

如未指定，則徽章不會變更。

如果設為 0，系統會移除徽章。

與使用者點擊通知相關的動作。

對應至 APN 酬載中的 category。

通知的副標題。

應用程式字串資源中的主體字串鍵，用來將內文文字本地化至使用者目前的本地化。

對應至 APN 酬載中的 loc-key。

詳情請參閱「 酬載金鑰參考資料」和「 本地化遠端通知內容」。

用來取代 body_loc_key 中的格式指定碼的變數字串值，用來將內文本地化到使用者目前的本地化。

對應至 APN 酬載中的 loc-args。

詳情請參閱「 酬載金鑰參考資料」和「 本地化遠端通知內容」。

應用程式字串資源中標題字串的鍵，用來將標題文字本地化，為使用者目前的本地化內容。

對應至 APN 酬載中的 title-loc-key。

詳情請參閱「 酬載金鑰參考資料」和「 本地化遠端通知內容」。

用來取代 title_loc_key 中的格式指定碼的變數字串值，用來將標題文字本地化成使用者目前的本地化。

對應至 APN 酬載中的 title-loc-args。

詳情請參閱「 酬載金鑰參考資料」和「 本地化遠端通知內容」。

通知的標題。

通知的內文。

通知的頻道 ID (在 Android O 中新增)。

應用程式必須先使用這個管道 ID 建立頻道，才能接收任何含有這個頻道 ID 的通知。

如果您未在要求中傳送這個頻道 ID，或是尚未建立應用程式提供的頻道 ID，FCM 會使用應用程式資訊清單中指定的頻道 ID。

通知圖示。

將可繪製資源 myicon 的通知圖示設為 myicon。如果您未在要求中傳送這個金鑰，FCM 會顯示應用程式資訊清單中指定的啟動器圖示。

裝置收到通知時要播放的音效。

支援 "default" 或應用程式中隨附的音效資源檔案名稱。音效檔案必須位於 /res/raw/ 中。

用於取代通知導覽匣中現有通知的 ID。

如未指定，每個要求都會建立新通知。

如果已指定，且已顯示含有相同標記的通知，新通知會取代通知導覽匣中的現有通知。

通知的圖示顏色，以 #rrggbb 格式表示。

與使用者點擊通知相關的動作。

如果有指定，系統就會在使用者點選通知時啟動具有相符意圖篩選器的活動。

應用程式字串資源中的主體字串鍵，用來將內文文字本地化至使用者目前的本地化。

詳情請參閱「 字串資源」。

用來取代 body_loc_key 中的格式指定碼的變數字串值，用來將內文本地化到使用者目前的本地化。

詳情請參閱「 格式設定和樣式」一文。

應用程式字串資源中標題字串的鍵，用來將標題文字本地化，為使用者目前的本地化內容。

詳情請參閱「 字串資源」。

用來取代 title_loc_key 中的格式指定碼的變數字串值，用來將標題文字本地化成使用者目前的本地化。

詳情請參閱「 格式設定和樣式」一文。

通知的標題。

通知的內文。

通知圖示所使用的網址。

與使用者點擊通知相關的動作。

所有網址值都必須使用 HTTPS。

這個參數會指定接收訊息的用戶端應用程式 (註冊權杖)。

多點傳播訊息 (傳送至多個註冊權杖) 只能使用 HTTP JSON 格式。

這個參數會指定訊息酬載的鍵/值組合。鍵/值參數沒有數量限制，但訊息總大小限制為 4,096 個位元組。

舉例來說，在 Android 中，"data.score"."3x1" 會產生額外名稱為 score 的意圖，且字串值為 3x1。

金鑰不得為保留字詞 (「from」、「message_type」)，或是任何以「google」或「gcm」開頭的字詞。請勿使用這個資料表中定義的任何字詞 (例如 collapse_key)。

• message_id：為每則成功處理的訊息指定專屬 ID 的字串。
• error：此字串用於指定處理接收者訊息時發生的錯誤。可能的值列於表 9。

• 用戶端應用程式向 FCM 取消註冊。
• 如果用戶端應用程式自動取消註冊，當使用者解除安裝應用程式時，就可能發生這種情況。例如在 iOS 裝置中，如果 APN 意見回饋服務回報 APNs 權杖無效，
• 如果註冊權杖過期 (例如，Google 可能會決定更新註冊權杖，或 iOS 裝置的 APN 權杖已過期)。
• 如果用戶端應用程式已更新，但新版本尚未設定為接收訊息，

• 缺少 Authorization 標頭，或 HTTP 要求中的語法無效。
• 指定伺服器金鑰所屬的 Firebase 專案有誤。
• 僅限舊版伺服器金鑰：源自於伺服器金鑰 IP 未加入許可清單的伺服器。

伺服器無法及時處理要求。重試相同要求，但你必須：

• 如果 FCM 連線伺服器的回應中包含 Retry-After 標頭，請採用該標頭。
• 在重試機制中實作指數輪詢。(舉例來說，如果您在第一次重試前等待一秒，請等待至少兩秒再下一次，接著是 4 秒，依此類推)。如果要傳送多則訊息，請以隨機的隨機數量分別延遲每則訊息，以免同時對所有訊息發出新的要求。

系統會將會造成問題風險的寄件者列入黑名單。

傳送到特定裝置的訊息頻率過高。如果 Apple 應用程式傳送訊息的速率超過 APN 限制，就可能收到這則錯誤訊息

請減少傳送至這部裝置的訊息數量，並使用指數輪詢重試功能。