Firebase 雲端通訊 HTTP 通訊協定

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

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

這個參數可指定多點傳播訊息的接收者，例如訊息 。

值必須為註冊權杖陣列，以便傳送該 多點傳播訊息陣列必須包含介於 1 至 1000 之間 註冊權杖如要傳送訊息至單一裝置，請使用 to 參數。

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

這個參數可指定條件式的邏輯運算式； 判斷訊息目標

支援的條件：主題，格式為「yourTopic」主題。這個 不區分大小寫。

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

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

這個參數可識別訊息群組 (例如 collapse_key: "Updates Available") 可收合，因此只有 上次傳送訊息時，就會收到最後一則訊息這麼做是為了避免使用者一併傳送 您會有許多相同訊息。

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

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

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

預設情況下，通知訊息的優先程度較高，而資料訊息則是以高優先順序傳送 以一般優先順序傳送一般優先順序可為用戶端應用程式的 但除非需要立即交付，否則應使用電量。 如果是優先順序為「一般」的訊息，應用程式可能會收到含有 未指定延遲時間

如果傳送的是高優先順序的訊息，系統就會立即傳送訊息，並將應用程式傳送到應用程式 可顯示通知

在 Apple 平台上，請使用這個欄位代表 content-available APN 酬載。收到通知或訊息並設為 true 時， 系統會喚醒閒置的用戶端應用程式，而 APN 會以無訊息通知的形式傳送訊息 而非透過 FCM請注意，APN 中的靜音通知無法 應用程式保證會送達，而且會受到許多因素影響，例如使用者開啟低功耗功能 模式、強制退出應用程式等。在 Android 裝置上，資料訊息預設會喚醒應用程式。啟用 Chrome，目前不支援。

如果是 Apple 平台，請使用這個欄位 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 未加入許可清單的伺服器。

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

• 如果回應中的 Retry-After 標頭包含 FCM 連線伺服器。
• 在重試機制中實作指數輪詢。(例如，假設你未在 1 秒內耐心等候， 第一次重試前，請等待至少兩秒再重試，然後等待 4 秒，依此類推。 如要傳送多封郵件，請在每則訊息加上額外隨機延遲 避免同時對所有訊息發出新的要求。

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

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

減少 傳送到這部裝置及傳送的訊息數量 使用指數輪詢 重試傳送。