您可以針對用戶端和伺服器用途設定範本。凡是實作遠端設定 Firebase 用戶端 SDK 的應用程式執行個體 (包括 Android、Apple、Web、Unity、Flutter 和 C++ 應用程式),系統都會提供用戶端範本。伺服器特定範本中的遠端設定參數和值,會提供給使用 Firebase Admin Node.js SDK v12.1.0 以上版本的遠端設定實作項目 (包括 Cloud Run 和 Cloud Functions)。
使用 Firebase 主控台或遠端設定後端 API 時,您可以定義一或多個參數 (鍵/值組合),並為這些參數提供應用程式內預設值。定義參數值即可覆寫應用程式內預設值。參數鍵和參數值是字串,但當您在應用程式中使用這些值時,參數值可能會轉換為其他資料類型。
您可以使用 Firebase 控制台、Admin SDK 或 Remote Config REST API 為參數建立新的預設值,以及用來指定應用程式執行個體群組的條件值。每次在 Firebase 控制台中更新設定時,Firebase 都會建立並發布新版遠端設定範本。系統會儲存先前的版本,方便您視需要擷取或復原。您可以透過 Firebase 控制台、Firebase Admin SDK 和 REST API 使用這些作業,詳情請參閱「管理遠端設定範本版本」。
本指南將說明參數、條件、規則、條件值,以及如何在遠端設定伺服器和應用程式中優先處理各種參數值,並提供用於建立條件的規則類型的詳細資訊。
條件、規則和條件值
條件可用於指定一組應用程式執行個體。條件由一或多個規則組成,這些規則必須全部評估為 true
,才能評估特定應用程式執行個體為 true
的條件。如果規則的值未定義 (例如沒有可用的值時),該規則會評估為 false
。
舉例來說,定義應用程式啟動頁面的參數可以使用簡易規則 if device_os = Android
,根據 OS 類型顯示不同的圖片:
或者,時間條件可用於控制應用程式顯示特別促銷商品的時機。
一個參數可以有多個使用不同條件的條件值,且參數可以在專案中共用條件。在 Firebase 控制台的「Parameters」分頁中,您可以查看每個參數的條件值的擷取百分比。這項指標代表在最近 24 小時內收到每個值的要求百分比。
參數值優先順序
一個參數可能有多個相關聯的條件值。下列規則可決定要從遠端設定伺服器擷取哪些值,以及哪些值會在特定時間點的特定應用程式執行個體中使用:
系統會根據下列優先順序清單擷取參數值
首先,如果任何條件為特定應用程式執行個體評估為
true
,系統會套用條件值。如果多項條件評估為true
,系統會優先採用 Firebase 控制台 UI 中顯示的第一個 (頂端) 條件,並在應用程式從後端擷取值時提供與該條件相關聯的條件值。您可以在「Conditions」(條件) 分頁中拖曳條件來變更條件的優先順序。如果沒有條件值符合
true
的條件,系統會在應用程式從後端擷取值時,提供遠端設定的預設值。如果後端沒有參數,或是預設值設為「Use-app default」,則應用程式擷取值時,系統不會為該參數提供任何值。
在您的應用程式中,get
方法會根據以下優先順序清單傳回參數值
- 如果已從後端擷取值並加以啟用,應用程式會使用擷取的值。已啟用的參數值為永久性。
如果未從後端擷取任何值,或是從遠端設定後端擷取的值尚未啟用,應用程式會使用應用程式內預設值。
如要進一步瞭解如何取得及設定預設值,請參閱下載遠端設定範本預設值。
如果未設定任何應用程式內預設值,應用程式會使用靜態類型值 (例如
int
使用0
,boolean
使用false
)。
下圖摘要說明系統如何在遠端設定後端和應用程式中決定參數值的優先順序:
參數值資料類型
遠端設定可讓您為每個參數選取資料類型,並在更新範本前根據該類型驗證所有遠端設定值。資料類型會在 getRemoteConfig
要求上儲存及傳回。
目前支援的類型如下:
String
Boolean
Number
JSON
在 Firebase 控制台 UI 中,您可以從參數鍵旁的下拉式選單選取資料類型。您可以在參數物件中使用 value_type
欄位設定 REST API 類型。
參數群組
遠端設定可讓您將參數分組,使 UI 和心理模型更有條理。
舉例來說,假設您需要在推出新的登入功能時啟用或停用三種驗證類型,透過遠端設定,您可以建立三個參數來啟用所需類型,然後在名為「新登入」的群組中整理這些參數,不需要加入前置字串或特殊排序。
您可以使用 Firebase 控制台或 Remote Config REST API 建立參數群組。您建立的每個參數群組在遠端設定範本中都會有不重複的名稱。建立參數群組時,請注意下列事項:
- 參數一次只能加到一個群組,且所有參數的參數鍵不得重複。
- 參數群組名稱的長度上限為 256 個半形字元。
- 如果您同時使用 REST API 和 Firebase 控制台,請務必更新所有 REST API 邏輯,以便在發布時處理參數群組。
使用 Firebase 控制台建立或修改參數群組
您可以在 Firebase 控制台的「Parameters」分頁中將參數分組。如何建立或修改群組:
- 選取「管理群組」。
- 勾選要新增的參數核取方塊,然後選取「Move to group」。
- 選取現有群組,或輸入名稱和說明來建立新群組,然後選取「Create new group」。儲存群組後,您可以使用「Publish changes」(發布變更) 按鈕發布群組。
透過程式建立群組
Remote Config REST API 會自動提供建立及發布參數群組的方法,假設您熟悉 REST 且已設定授權對 API 的要求,則可以執行下列步驟,以程式輔助的方式管理群組:
- 擷取目前的範本
- 新增 JSON 物件來代表參數群組
- 使用 HTTP PUT 要求發布參數群組。
parameterGroups
物件包含群組鍵,以及巢狀說明和分組參數清單。請注意,每個群組金鑰在全域範圍內都不得重複。
例如,以下摘錄範本修訂版本「new menu」參數群組,以及一個參數 pumpkin_spice_season
:
{ "parameters": {}, "version": { "versionNumber": "1", … }, "parameterGroups": { "new menu": { "description": "New Menu", "parameters": { "pumpkin_spice_season": { "defaultValue": { "value": "true" }, "description": "Whether it's currently pumpkin spice season." } } } } }
條件規則類型
Firebase 控制台支援下列規則類型。Remote Config REST API 也提供同等功能,詳情請參閱條件運算式參考資料。
規則類型 | 運算子 | 值 | 注意事項 |
---|---|---|---|
應用程式 | == | 針對與 Firebase 專案相關聯的應用程式,從應用程式 ID 清單中選取。 | 將應用程式新增至 Firebase 時,您必須輸入軟體包 ID 或 Android 套件名稱,其定義的屬性會在遠端設定規則中顯示為「應用程式 ID」。 這項屬性的使用方式如下:
|
應用程式版本 |
字串值: 完全符合、 包含、 不包含、 規則運算式 數值: =、≠、>、≥、<、≤ |
指定要指定的應用程式版本。 使用這項規則前,您必須使用「應用程式 ID」規則選取與 Firebase 專案相關聯的 Android/Apple 應用程式。 |
Apple 平台:使用應用程式的 CFBundleShortVersionString。 注意:請確認您的 Apple 應用程式使用的是 Firebase Apple 平台 SDK 6.24.0 以上版本,因為 CFBundleShortVersionString 並非透過較舊版本傳送 (請參閱版本資訊)。 Android 裝置:使用應用程式的 versionName。 這項規則的字串比較會區分大小寫。使用完全符合、「包含」、「不包含」或「規則運算式」運算子時,您可以選取多個值。 使用規則運算式運算子時,請以 RE2 格式建立規則運算式。規則運算式符合完整或部分目標版本字串。您也可以使用 ^ 和 $ 錨點來比對目標字串的開頭、結尾或整個區域。 |
版本編號 |
字串值: 完全符合、 包含、 不包含、 規則運算式 數值: =、≠、>、≥、<、≤ |
指定要指定的應用程式版本。 使用這項規則前,您必須使用「應用程式 ID」規則選取與 Firebase 專案相關聯的 Apple 或 Android 應用程式。 |
這個運算子僅適用於 Apple 和 Android 應用程式。這個 ID 對應至應用程式適用於 Apple 的 CFBundleVersion 和 Android 適用的 versionCode。這項規則的字串比較會區分大小寫。 使用「完全符合」、「包含」、「不包含」或「規則運算式」運算子時,您可以選取多個值。 使用規則運算式運算子時,請以 RE2 格式建立規則運算式。規則運算式可與所有或部分目標版本字串相符。您也可以使用 ^ 和 $ 錨點來比對目標字串的開始、結束或整個設定。 |
平台 | == | iOS Android 網頁版 |
|
作業系統 | == |
指定要指定的作業系統。 使用這項規則前,您必須使用「應用程式 ID」規則,選取與 Firebase 專案相關聯的網頁應用程式。 |
如果作業系統及其版本與指定清單中的目標值相符,這項規則就會針對特定網頁應用程式執行個體評估為 true 。 |
瀏覽器 | == |
指定要指定的瀏覽器。 使用這項規則前,您必須使用「應用程式 ID」規則,選取與 Firebase 專案相關聯的網頁應用程式。 |
如果瀏覽器及其版本與指定清單中的目標值相符,這項規則就會針對特定網頁應用程式執行個體評估為 true 。 |
裝置類別 | 是、不是 | 行動 | 這項規則會評估存取網頁應用程式的裝置,是行動裝置或非行動裝置 (電腦或主控台)。這個規則類型僅適用於網頁應用程式。 |
語言 | 位於 | 選取一或多種語言。 | 如果安裝應用程式執行個體的裝置使用下列任一種語言,這項規則就會評估為 true 。 |
國家/地區 | 位於 | 選取一或多個區域或國家/地區。 | 如果特定應用程式執行個體位於列出的任何地區或國家/地區,這項規則就會評估為 true 。裝置國家/地區代碼取決於要求中的裝置 IP 位址,或由 Firebase Analytics 決定的國家/地區代碼 (如果與 Firebase 共用 Analytics (分析) 資料)。 |
使用者目標對象 | 包括至少一個 | 從您為專案設定的 Google Analytics (分析) 目標對象清單中,選取一或多個目標對象。 | 這項規則需要應用程式 ID 規則,才能選取與 Firebase 專案相關聯的應用程式。 注意:許多 Analytics (分析) 目標對像是由事件或使用者屬性定義,這些屬性可根據應用程式使用者的動作而定,因此「目標對像中的使用者」規則可能需要一段時間才會在特定應用程式執行個體中生效。 |
使用者屬性 |
字串值:
包含、 不包含、 完全符合、 規則運算式 數值: =、≠、>、≥、<、≤ 注意:在用戶端中,您只能針對使用者屬性設定字串值。針對使用數字運算子的條件,遠端設定會將對應使用者屬性的值轉換為整數/浮點值。 |
從可用的 Google Analytics (分析) 使用者屬性清單中選取。 | 如要瞭解如何運用使用者屬性,針對非常具體的使用者族群自訂應用程式,請參閱「
遠端設定和使用者屬性」。 如要進一步瞭解使用者屬性,請參閱下列指南: 使用「完全符合」、「包含」、「不包含」或「規則運算式」運算子時,您可以選取多個值。 使用規則運算式運算子時,請以 RE2 格式建立規則運算式。規則運算式可與所有或部分目標版本字串相符。您也可以使用 ^ 和 $ 錨點來比對目標字串的開始、結束或整個設定。 注意:建立遠端設定條件時,目前無法使用自動收集的使用者屬性。 |
隨機百分比中的使用者 | 滑桿 (位於 Firebase 控制台,REST API 會使用 <= 、> 和 between 運算子。 |
0-100 TB | 使用這個欄位將變更套用至應用程式執行個體的隨機樣本 (樣本大小為 0.0001% 的大小),並使用滑桿小工具將隨機重組的使用者 (應用程式執行個體) 區隔為群組。 根據該專案中定義的「種子」,每個應用程式執行個體會永久對應至一個隨機整數或分數。 除非您修改種子值,否則規則將使用預設金鑰 (在 Firebase 控制台中會顯示為「編輯種子」)。只要清除「種子」欄位,即可傳回使用預設索引鍵的規則。 如要在指定百分比範圍內持續處理相同的應用程式執行個體,請在所有條件中使用相同的種子值。或者,您也可以指定新的種子,藉此針對特定百分比範圍隨機指派新的應用程式執行個體群組。 舉例來說,如要針對 5% 的應用程式使用者分別建立兩個相關條件,您可以設定一個條件來比對 0% 到 5% 之間的百分比,並設定另一個條件來比對 5% 至 10% 之間的範圍。如要讓部分使用者隨機出現在兩個群組中,請為每個條件內的規則使用不同的種子值。 |
已匯入的區隔 | 位於 | 選取一或多個已匯入的區隔。 | 這項規則需要設定自訂匯入的區隔。 |
日期/時間 | 之前、之後 | 指定的日期和時間,以裝置時區或指定時區為準,例如「(GMT+11) 雪梨時間」。 | 比較目前時間與裝置擷取時間。 |
初次開啟 | 之前、之後 | 指定的日期和時間 (以指定時區為準)。 | 比對在指定時間範圍內初次開啟指定應用程式的使用者。 需要下列 SDK:
|
安裝 ID | 位於 | 指定一或多個要指定的安裝 ID (最多 50 個)。 | 如果特定安裝作業的 ID 位於逗號分隔的值清單中,這項規則就會評估為 true 。如要瞭解如何取得安裝 ID,請參閱 擷取用戶端 ID 一文。 |
使用者確實存在 | (無運算子) | 指定目前專案中所有應用程式的所有使用者。 |
請使用這項條件規則來比對專案中的所有使用者,無論應用程式或平台為何。
|
搜尋參數和條件
您可以使用遠端設定「參數」分頁頂端的搜尋框,在 Firebase 控制台搜尋專案的參數鍵、參數值和條件。
參數和條件的限制
每項 Firebase 專案中,最多可以有 2,000 個參數和 500 個條件。參數鍵長度上限為 256 個字元,開頭必須是底線或英文字母字元 (A-Z、a-z),也可以包含數字。專案中參數值字串的總長度不得超過 1,000,000 個字元。
查看參數和條件的異動
您可以透過 Firebase 主控台查看遠端設定範本的最新異動。對於每個個別參數和條件,您可以:
查看上次修改參數或條件的使用者名稱。
如果變更發生在同一天內,請查看將變更發布至有效遠端設定範本後經過的分鐘數或小時數。
如果變更發生在一或多天內,請查看變更發布至有效遠端設定範本的日期。
參數更新
在遠端設定「參數」頁面中,「上次發布時間」資料欄會顯示修改每個參數的最後一位使用者,以及變更的上次發布日期:
如要查看已分組參數的變更中繼資料,請展開參數群組。
如要依照發布日期遞增或遞減排序,請按一下「Lastpublish」(上次發布時間) 資料欄標籤。
狀況更新
在遠端設定的「Conditions」(條件) 頁面中,每個條件下方的「Lastmodify」(上次修改日期) 旁,都會顯示上次修改條件的使用者和修改日期。
後續步驟
如要開始設定 Firebase 專案,請參閱「設定 Firebase 遠端設定專案」一文。