No results found
We couldn't find anything using that term, please try searching for something else.
firebase Cloud Messaging (FCM) 提供多種訊息傳送選項和功能。本頁面提供的資訊旨在協助您瞭解不同類型的 FCM 訊息,以及如何使用這些訊息 。 訊息類型 您可以使用 FCM 向用戶端傳送兩種類型的訊息 : 通知訊息,有時也稱為「顯示訊息」。這些事件會由FCM
firebase Cloud Messaging (FCM) 提供多種訊息傳送選項和功能。本頁面提供的資訊旨在協助您瞭解不同類型的 FCM 訊息,以及如何使用這些訊息 。
您可以使用 FCM 向用戶端傳送兩種類型的訊息 :
通知訊息包含一組預先定義的使用者可見鍵。相反地,資料訊息只包含使用者定義的自訂鍵/值組合。通知訊息可包含選用的資料酬載。兩種訊息類型的酬載大小上限為 4096 個位元組,但從 firebase 主控台傳送訊息時,系統會強制限制為 1000 個字元 。
如要讓 FCM SDK 在應用程式於背景執行時自動顯示通知,請使用通知訊息。如要使用自己的用戶端應用程式程式碼處理訊息,請使用資料訊息。
FCM 可以傳送通知訊息,包括選用的資料酬載。在這種情況下 ,FCM 會負責顯示通知酬載,而用戶端應用程式會處理資料酬載。
如要進行測試,或是用於行銷和使用者再參與,您可以使用firebase 控制台傳送通知訊息。firebase 控制台提供以數據為基礎的 A / b 測試功能,協助您調整及改善行銷訊息 。
如要使用程式輔助方式透過 Admin SDK 或FCM 通訊協定傳送通知訊息,請為通知訊息的使用者可見部分,設定notification
鍵,並提供必要的預先定義鍵/值選項組合。舉例來說,以下是 IM 應用程式中 JSON 格式的通知訊息。使用者會在裝置上看到標題為「Portugal vs. Denmark」的訊息,以及「great match!」的文字:
{ "message": { "token":" bk3rnwte3h0 : ci2k_hhwgipodkcizvvdmexudfq3p1 ... ", "notification": { "title":"Portugal vs. Denmark", " body ":"great match!" } } }
應用程式在背景運作時,通知訊息會傳送至通知匣。對於前景應用程式,系統會使用回呼函式處理訊息 。
如需可用於建立通知訊息的完整預先定義鍵清單,請參閱 HTTP v1 通訊協定通知物件參考說明文件。
使用自訂鍵/值組合設定適當的鍵,以便將資料酬載傳送至用戶端應用程式。
請務必確保自訂鍵/值組合中沒有任何保留字。保留字詞包括「from」、「notification」、「message_type」或任何以「google」或「gcm」開頭的字詞。
舉例來說,以下是與上述相同的即時通訊應用程式中,以 JSON 格式呈現的訊息,其中資訊已封裝在常見的 data
鍵中,而用戶端應用程式應會解讀內容 :
{ " message " : { " token":"bk3rnwte3h0 : ci2k_hhwgipodkcizvvdmexudfq3p1 ... " , " datum " : { " Nick " : " Mario " , " body " : " great match ! " , " room " : " PortugalVSDenmark " } } }
上例顯示頂層或常見的 data
欄位用法,這些欄位會在收到訊息的所有平台上由用戶端解讀。在每個平台上,用戶端應用程式都會在回呼函式中接收資料酬載。
Android 傳輸層 (請參閱 FCM 架構) 會使用點對點加密。視您的需求而定,您可以決定是否要為資料訊息啟用端對端加密。FCM 無法提供端對端解決方案。不過,您可以使用 Capillary 或 DTLS 等外部解決方案。
您可以透過程式設計或firebase 控制台,傳送含有自訂鍵 / 值組合選用酬載的通知訊息。在
通知編輯器中,使用進階選項中的自訂資料欄位 。
應用程式在收到同時包含通知和資料酬載的訊息時,其行為取決於應用程式處於背景或前景,也就是說,取決於應用程式在收到訊息時是否處於活動狀態。
以下是 JSON 格式的訊息,其中包含 notification
鍵和 data
鍵:
{ " message " : { " token":"bk3rnwte3h0 : ci2k_hhwgipodkcizvvdmexudfq3p1 ... " , " notification " : { " title":"portugal vs. Denmark " , " body":"great match ! " } , " datum " : { " Nick " : " Mario " , " room " : " PortugalVSDenmark " } } }
firebase Admin SDK 和 FCM v1 HTTP 通訊協定都允許訊息要求設定 message
物件中可用的所有欄位。包括 :
AndroidConfig
和 WebpushConfig
),僅由在指定平台上執行的應用程式執行個體解讀。您可以使用特定平台的區塊,靈活地為不同平台自訂訊息,確保訊息在收到時能正確處理。FCM 後端會考量所有指定參數,並為各平台自訂訊息 。
使用常用欄位時,請注意:
無論平台為何,所有應用程式例項都能解讀下列常見欄位:
請在下列情況下使用平台專屬欄位:
如要只將值傳送至特定平台,請不要使用通用欄位,請使用特定平台的欄位。舉例來說,如果您想只將通知傳送給 Apple 平台和網頁,但不傳送給 Android,就必須使用兩組不同的欄位,一組用於 Apple,另一組用於網頁 。
傳送含有特定傳送選項的郵件時,請使用特定平台的欄位進行設定。您可以視需要為每個平台指定不同的值。不過,即使您想在各平台上設定相同的值,也必須使用平台專屬欄位。這是因為每個平台對這個值的解讀方式略有不同。舉例來說,Android 將生命週期設為以秒為單位的到期時間,而 Apple 則將生命週期設為到期日期。
以下是 v1 傳送要求,可將常見的通知標題和內容傳送至所有平台,但也會傳送一些平台專屬的覆寫值。具體來說,要求如下:
click_action
和 category
。{ "message": { "token":" bk3rnwte3h0 : ci2k_hhwgipodkcizvvdmexudfq3p1 ... ", "notification": { "title":" match update ", " body ":"Arsenal goal in added time, score is now 3-0" } , " android ": { " ttl ":" 86400s ", "notification"{ "click_action":"OPEN_ACTIVITY_1" } } , "apns": { "headers": { "apns-priority": "5", } , " payload ": { "aps": { " category ": "NEW_MESSAGE_CATEGORY" } } } , " webpush ": { "headers": { "TTL":"86400" } } } }
如要進一步瞭解郵件主體中平台專屬區塊可用的鍵,請參閱 HTTP v1 參考說明文件。如要進一步瞭解如何建立含有訊息主體的傳送要求,請參閱「建立傳送要求」。
FCM 為傳送至 Android 裝置的訊息提供特定的傳送選項組合,並允許在 Apple 平台和網站上使用類似的選項。舉例來說,Android 支援透過FCM 的 collapse_key
使用「可摺疊」訊息行為,Apple 則是透過apns-collapse-id
,而 JavaScript/網站則是透過 Topic
。詳情請參閱本節和相關參考文件中的說明。
不可收合的訊息表示每則個別訊息都會傳送至裝置。不收折疊的訊息會提供一些實用的內容,而非收折疊的訊息 (例如傳送給行動應用程式,以便與伺服器聯絡以擷取資料的無內容「ping」)。
不顯示收合按鈕的訊息常見用途包括即時通訊訊息或重要訊息。舉例來說,在即時通訊應用程式中,您會希望傳送每則訊息,因為每則訊息都有不同的內容。
在 Android 裝置上,最多可儲存 100 則訊息,且不會折疊。如果達到限制,系統會捨棄所有儲存的訊息。裝置重新上線後,會收到一則特殊訊息,指出已達到上限。應用程式就能妥善處理這種情況,通常會要求應用程式伺服器進行完整同步處理。
可摺疊訊息是指尚未傳送至裝置的訊息,可能會被新訊息取代。
可摺疊訊息的常見用途是用於通知行動應用程式同步伺服器資料。舉例來說,體育應用程式會向使用者更新最新比分。只有最新的訊息才有參考價值。
如要在 Android 上將訊息標示為可摺疊,請在訊息酬載中加入 collapse_key
參數 。根據預設,摺疊鍵是firebase 主控台中登錄的應用程式套件名稱。FCM 伺服器可同時為每部裝置儲存四則不同的可摺疊訊息,每則訊息都有不同的摺疊鍵。如果超過這個數量 ,FCM 只會保留四個折疊鍵,且無法保證會保留哪些鍵。
根據預設,沒有酬載的專訊會折疊。通知訊息一律可摺疊,且會忽略collapse_key
參數 。
從效能角度來看,只要您的應用程式不需要使用不可收合訊息,則收合訊息會是較佳的選擇。不過,如果您使用可摺疊的訊息,請注意,FCM 在任何特定時間點,最多只允許FCM 使用每個註冊權杖的四個不同摺疊鍵。請勿超過這個數量,否則可能會導致無法預測的後果。
使用情境 | 傳送方式 | |
---|---|---|
不可收合 | 每則訊息對用戶端應用程式都很重要,因此必須傳送。 | 除了通知訊息之外,所有訊息預設都無法收合 。 |
可收合 | 如果有較新的訊息會顯示與用戶端應用程式無關的舊相關訊息,FCM 會取代舊訊息。例如:用於從伺服器啟動資料同步的訊息,或過期的通知訊息。 | 請在訊息要求中設定適當的參數 :
|
您可以為下游郵件指派傳送優先順序,有兩種選項:一般和高優先順序。雖然不同平台的行為略有差異,但一般和高優先順序訊息的傳送方式如下:
傳送資料訊息至 Apple 裝置時,優先順序必須設為 5 或一般優先順序。FCM 後端會拒絕優先順序較高的訊息,並顯示錯誤訊息 INVALID_ARGUMENT
。
以下是透過FCM HTTP v1 通訊協定傳送的一般優先訊息範例,用於通知雜誌訂閱者可下載新內容:
{ "message": { "topic":"subscriber-updates", "notification": { " body " : "This week's edition is now available.", "title" : "NewsMagazine.com", } , "data" : { "volume" : "3.21.15", "contents" : "http://www.news-magazine.com/world-week/21659772" } , " android ": { "priority":"normal" } , "apns": { "headers": { "apns-priority":"5" } } , " webpush ": { "headers": { "Urgency": "high" } } } }
如要進一步瞭解如何設定訊息優先順序,請參閱以下平台專屬詳細說明 :
FCM API 並非設計用於緊急警報或其他高風險活動,因為使用或發生 API 故障可能會導致死亡、人身傷害或環境損害 (例如核子設施、空中交通管制或維生系統的操作)。根據第 4.a 節,我們明確禁止任何這類用途。7 服務條款。您必須自行負責管理應用程式是否遵守「條款」,以及因違反「條款」而產生的任何損害。Google 提供的 API 為「現況」狀態,且保留隨時基於任何理由中止 API 或任何部分或功能,或您對這些項目的存取權的權利,且不對您或您的使用者負任何責任或其他義務。
FCM 通常會在訊息傳送後立即傳送。不過,這不一定可行。舉例來說,如果平台是 Android,裝置可能會關閉、離線或無法使用 。FCM 也可能會刻意延遲訊息,避免應用程式消耗過多資源,進而影響電池續航力 。
在這種情況下,FCM 會儲存訊息,並盡快傳送。雖然在大多數情況下這都沒問題,但有些應用程式可能會導致延遲訊息永遠無法傳送。舉例來說,如果訊息是來電或視訊通話通知,只有在通話結束前短短的一段時間內才有意義。或者,如果訊息是活動邀請,在活動結束後收到這類訊息就沒有用處 。
在 Android 和 Web/JavaScript 中,您可以指定訊息的最大生命週期。這個值必須是 0 到 2,419,200 秒 (28 天) 之間的時間長度,且對應於 FCM 儲存訊息並嘗試傳送訊息的最大時間長度。不含此欄位的請求預設為四週的上限期間 。
以下是這項功能的幾種可能用途:
指定訊息生命週期的另一個優點是,FCM 不會將可折疊訊息調節功能套用至有效時間值為 0 秒的訊息。FCM 會盡力處理必須立即傳送的訊息。請注意,如果 time_to_live
值為 0,表示系統會捨棄無法立即傳送的訊息。不過,由於這類訊息永遠不會儲存,因此可提供最佳的通知訊息傳送延遲時間。
以下是含有 TTL 的請求範例 :
{ "message": { "token":" bk3rnwte3h0 : ci2k_hhwgipodkcizvvdmexudfq3p1 ... ", "data": { "Nick" : "Mario", " body " : "great match!", "Room" : "PortugalVSDenmark" } , "apns": { "headers": { "apns-expiration":"1604750400" } } , " android ": { " ttl ":"4500s" } , " webpush ": { "headers": { "TTL":"4500" } } } }
當應用程式伺服器將訊息發布至 FCM,並收到訊息 ID 回應時,並不代表訊息已傳送至裝置。而是表示郵件已通過郵件系統的接受程序,訊息接受後的處理方式取決於許多因素。
在最佳情況下,如果裝置已連線至FCM、螢幕已開啟且沒有節流限制,系統會立即傳送訊息。
如果裝置已連線但處於 Doze 模式 ,FCM 會儲存低優先順序訊息,直到裝置離開 Doze 模式為止。這就是 collapse_key
標記發揮作用的地方:如果已經有訊息使用相同的折疊鍵 (和註冊權杖) 儲存在系統中,並等待傳送,舊訊息就會遭到捨棄,新訊息會取而代之 (也就是舊訊息會被新訊息折疊)。不過,如果未設定折疊鍵,系統會儲存新訊息和舊訊息,以便日後傳送。
如果裝置未連線至 FCM,系統會儲存訊息,直到建立連線為止 (再次遵循折疊鍵規則)。建立連線後,FCM 會將所有待處理訊息傳送至裝置。如果裝置從未再次連線 (例如已恢復原廠設定),訊息最終會逾時,並從 FCM 儲存空間中捨棄。除非設定 time_to_live
旗標,否則預設逾時時間為四週。
如要進一步瞭解訊息的傳送情況,請按照下列步驟操作:
如要進一步瞭解 Android 或 Apple 平台上的訊息遞送情況,請參閱
FCM 報表資訊主頁,這裡會記錄在 Apple 和 Android 裝置上傳送及開啟的訊息數量,以及 Android 應用程式「曝光次數」(使用者看到的通知) 資料。
對於已啟用直接管道訊息功能的 Android 裝置,如果裝置未連線至 FCM 超過一個月 ,FCM 仍會接受訊息,但會立即將其捨棄。如果裝置在您上次傳送資料訊息後的四週內連線,您的用戶端就會收到 onDeletedMessages() 回呼。應用程式就能妥善處理這種情況,通常會要求應用程式伺服器進行完整同步處理。
最後,當FCM 嘗試將訊息傳送至裝置,但應用程式已解除安裝時,FCM 會立即捨棄該訊息,並使註冊權杖失效。日後嘗試傳送訊息至該裝置時,就會導致NotRegistered
錯誤。
我們的目標是確保每則透過 FCM 傳送的訊息都能送達。不過,有時傳送每則訊息都會導致整體使用者體驗不佳。在其他情況下,我們需要提供限制,確保 FCM 可為所有寄件者提供可擴充的服務。本節所述的限制和配額類型有助於平衡這些重要因素 。
HTTP v1 API 為下游訊息引進了專案層級的每分鐘配額。預設配額為每分鐘 60 萬則訊息,可涵蓋 99 % 的FCM 開發人員,同時確保系統穩定性,並盡量減少尖峰專案的影響 。
尖峰流量模式可能會導致配額超出錯誤。在配額超出情況下,系統會傳回 HTTP is 狀態碼 狀態碼 429 ( QUOTA_EXCEEDED),直到下一個分鐘配額重新填滿為止。在超載情況下,系統也可能會傳回 429 回應,因此強烈建議您按照已發布的最佳化建議處理 429 回應 。
注意事項 :
您可以在 Google Cloud 控制台查看配額、用量和錯誤:
注意:這些圖表並未精確對齊配額分鐘,因此當流量似乎低於配額時,可能會傳送 429 錯誤。
申請提高配額前,請確認以下事項:
如果您符合這些條件,可以提交配額調高要求,最多可調高 25%,FCM 會盡力滿足您的要求 ( 但無法保證一定能調高 ) 。
如果您因即將推出的產品或臨時活動而需要更多訊息下游配額,請提前至少 15 天提出配額申請,以便我們有足夠的時間處理您的要求。如果是大型要求 (每分鐘超過 1,800 萬則訊息),則至少需要 30 天的通知時間。啟動和特殊事件要求仍須遵守用戶端錯誤比率和最佳做法規定。
另請參閱 FCM 配額的常見問題 。
主題訂閱新增/移除頻率上限為每個專案 3,000 QPS。
如要瞭解訊息傳送率,請參閱「分支節流 」 。
訊息分發是指將訊息傳送至多個裝置的程序,例如指定主題和群組,或是使用通知編輯器指定目標對象或使用者區隔。
訊息分支並非立即執行,因此有時會同時進行多個分支。我們將每項專案的並行訊息分支數量限制為 1,000 個。之後,我們可能會拒絕額外的分支要求,或將要求的分支延後,直到部分正在進行的分支完成為止。
實際可達的發散率會受到同時要求發散的專案數量影響。個別專案的發散率達到 10,000 QPS 並不少見,但這並非保證,而是系統總負載的結果。請注意,可用的分支容量會分配給各個專案,而非分支要求。因此,如果您的專案有兩個正在進行的發散,則每個發散只會看到可用的發散率的一半。如要盡量提高分支速度,建議您一次只執行一個有效的分支作業。
如上所述,可摺疊訊息是沒有內容的通知,設計目的是讓摺疊訊息彼此重疊。如果開發人員經常重複傳送相同的訊息給應用程式,我們會延遲 (節流) 訊息,以減少對使用者電池的影響。
舉例來說,如果您向單一裝置傳送大量新的電子郵件同步處理要求,我們可能會將下一個電子郵件同步處理要求延遲幾分鐘,以便裝置以較低的平均速率同步處理。這項節流功能的目的,是嚴格限制使用者在電池續航力方面的體驗。
如果您的用途需要高頻率的傳送模式,則不建議使用可摺疊的訊息。針對這類訊息,請務必在訊息中加入內容,以減少電池消耗 。
我們限制可摺疊訊息的數量,每個裝置每個應用程式最多 20 則,每 3 分鐘補充 1 則。
我們限制您連線至 FCM XMPP 伺服器的速度,每個專案每分鐘最多 400 個連線。這對訊息傳送而言並非問題,但對於確保系統穩定性而言相當重要。每個專案的 FCM 可同時處理 2500 個連線 。
針對使用 XMPP 的上游訊息,FCM 會將上游訊息限制為每個專案每分鐘 1,500,000 個,以免上游目的地伺服器超載。
我們將每部裝置的上游訊息數量限制在每分鐘 1,000 則,以防惡意應用程式行為耗盡電池電量。
針對 android,您最多可向單一裝置傳送 240 則訊息 / 分鐘和 5,000 則訊息 / 小時。這個高門檻旨在允許短期流量激增,例如使用者透過即時通訊快速互動時。這項限制可避免傳送邏輯中的錯誤,導致裝置電量意外耗盡 。
在 iOS 中,如果頻率超過 APN 限制,我們會傳回錯誤 。
注意 : 請勿經常傳送接近這個上限的訊息。這可能會浪費使用者的資源,且您的應用程式可能會被標示為濫用。
如果貴機構有防火牆來限制來自或前往網際網路的流量,您必須設定防火牆,允許行動裝置連線至 FCM,讓網路上的裝置能夠接收訊息。FCM 通常會使用 5228 埠,但有時也會使用 443、5229 和 5230 。
對於連線至您網路的裝置,FCM 不會提供特定 IP,因為我們的 IP 範圍變動頻繁,防火牆規則可能會過時,進而影響使用者體驗。理想情況下,您應將通訊埠 5228-5230 和 443 加入白名單,且不設 IP 限制。不過,如果您必須設有 IP 限制,請將 goog.json 中列出的所有 IP 位址加入許可清單。這份龐大的清單會定期更新,建議您每月更新規則。防火牆 IP 限制造成的問題通常會間歇性發生,且難以診斷。
我們提供一組可加入許可清單的網域名稱,而非 IP 位址。這些主機名稱如下所列。如果我們開始使用其他主機名稱,我們會在這裡更新清單。使用防火牆規則的網域名稱,在防火牆裝置中可能有效,也可能不有效 。
要開啟的 TCP 通訊埠:
要開啟的主機名稱 :
網路位址轉譯和/或具狀態的封包檢查防火牆:
如果您的網路採用網路位址轉譯 (NAT) 或有狀態封包檢查 (SPI) 功能,請為透過 5228-5230 連接埠的連線,設定 30 分鐘或更長的逾時時間。這可讓我們提供可靠的連線服務,同時降低使用者行動裝置的耗電量。
firebase Cloud Messaging 會採取各種步驟,確保從手機到伺服器的推播訊息連線可靠且盡可能可用。使用 VPN 會使這項工作變得複雜 。
VPN 會遮蔽 FCM 需要調整連線的基礎資訊,以便盡可能提高可靠性和電池續航力。在某些情況下,VPN 會主動中斷長時間連線,導致使用者體驗不佳,因為訊息可能會遺漏或延遲,電池費用也可能會偏高。當 VPN 設定允許我們這麼做時,我們會使用加密連線 (透過基礎網路 Wi-Fi 或 LTE) 略過 VPN,以確保可靠且省電的使用體驗。FCM 使用可繞過 VPN 的功能,僅限於 FCM 推播通知管道。其他 FCM 流量 (例如註冊流量) 會在 VPN 處於啟用狀態時使用 VPN。當 FCM 連線略過 VPN 時,就會失去 VPN 可能提供的額外優勢,例如 IP 遮罩 。
不同的 VPN 會採用不同的方法,控制是否可略過 VPN。如需操作說明,請參閱特定 VPN 的說明文件。
如果未將 VPN 設為可繞過,firebase Cloud Messaging 就會使用 VPN 網路連線至伺服器。這可能會導致訊息延遲,並且可能會導致電池使用量增加,因為 Cloud Messaging 會透過 VPN 連線維持連線。
視您要實作的 FCM 功能而定,您可能需要 firebase 專案中的下列憑證:
專案 ID | firebase 專案的專屬 ID,用於向 FCM v1 HTTP 端點提出要求。這個值可在 firebase 控制台的「設定」窗格中找到。 |
註冊權杖 |
用於識別每個用戶端應用程式執行個體的專屬符記字串。單一裝置和裝置群組訊息需要註冊權杖。請注意,註冊權杖必須保密。 |
寄件者 ID | 這是您建立 firebase 專案時建立的專屬數值,可在 firebase 控制台「設定」窗格中的 Cloud Messaging 分頁中找到。寄件者 ID 可用於識別可將訊息傳送至用戶端應用程式的每位寄件者。 |
存取權杖 | 短效 OAuth 2.0 權杖,可授權要求存取 HTTP v1 API。這個符記會與屬於 firebase 專案的服務帳戶相關聯。如要建立及輪替存取權權杖,請按照「 授權傳送要求」一文中的步驟操作。 |
伺服器金鑰 (適用於 **已淘汰** 的舊版通訊協定) |
授權應用程式伺服器存取 Google 服務的伺服器金鑰,包括透過已淘汰的firebase Cloud Messaging 舊版通訊協定傳送訊息。 重要事項:請勿在用戶端程式碼的任何位置加入伺服器金鑰。此外,請務必只使用伺服器金鑰來授權應用程式伺服器。FCM 會拒絕 Android、Apple 平台和瀏覽器金鑰 。 |