firebase-admin.remote-config package

Firebase 遠端設定。

函式

函式	說明
getRemoteConfig(應用程式)	取得預設應用程式或特定應用程式的 RemoteConfig 服務。getRemoteConfig()無需引數即可存取預設應用程式的 RemoteConfig 服務，或以 getRemoteConfig(app) 的方式存取與 RemoteConfig 相關聯的特定應用程式。

類別

類別	說明
RemoteConfig	Firebase RemoteConfig 服務介面。

列舉

列舉	說明
PercentConditionOperator (百分比條件運算子)	定義支援的百分比條件運算子。

介面

介面	說明
And 條件	代表一組條件，且這些條件評估為 true。
ExplicitParameterValue	代表明確參數值的介面。
GetServerTemplateOptions	代表將 ServerTemplate 執行個體化時可用的選用引數。
InAppDefaultValue	代表應用程式內預設值的介面。
InitServerTemplateOptions	代表同步 ServerTemplate 時可用的選用引數。
ListVersions 選項	代表遠端設定清單版本作業選項的介面。
ListVersionsResult	代表遠端設定範本版本清單的介面。
MicroPercentRange	代表要指定的百分位數上限，以微百分比為單位。這個值必須介於 [0 和 100000000] 之間
NamedCondition	代表資料層中的遠端設定條件。條件可指定特定一群使用者。這些條件清單是由遠端設定範本的一部分。
OneOfCondition	代表可能是其中一種類型的條件。只會處理第一個定義的欄位。
Or 條件	代表一組條件，評估的結果為 true。
百分比條件	代表比較執行個體偽隨機百分位數與指定上限的條件。
RemoteConfigCondition	代表遠端設定條件的介面。條件可指定特定一群使用者。這些條件的清單組成遠端設定範本。
RemoteConfigParameter	代表遠端設定參數的介面。參數必須至少有 defaultValue 或 conditionalValues 項目，參數才能發揮作用。
RemoteConfigParameterGroup	代表遠端設定參數群組的介面。將參數分組僅用於管理，不會影響用戶端擷取參數值。
RemoteConfigTemplate	代表遠端設定用戶端範本。
RemoteConfigUser	代表遠端設定使用者的介面。
伺服器設定	代表評估伺服器範本後產生的設定。
ServerTemplate	代表遠端設定伺服器範本的有狀態抽象化機制。
ServerTemplateData	代表遠端設定伺服器範本中的資料。
值	使用中繼資料和類型安全 getter 納入參數值。型別安全 getter 可從遠端變更到參數名稱和類型，插入應用程式邏輯。
版本	代表遠端設定範本版本的介面。僅供輸出 (版本說明除外)。內含特定版本的遠端設定範本中繼資料。所有欄位都是在指定遠端設定範本發布時設定。版本的說明欄位可在 publishTemplate 呼叫中指定。

型別別名

類型別名	說明
預設設定	定義應用程式內預設參數值的格式。
EvaluationContext	代表範本評估輸入信號。
ParameterValueType	代表遠端設定參數值資料類型的類型。如未指定，預設值為 STRING。
RemoteConfigParameterValue	代表遠端設定參數值的類型。RemoteConfigParameterValue 可以是 ExplicitParameterValue 或 InAppDefaultValue。
ServerTemplateDataType	代表可於 ServerTemplate 設定的遠端設定伺服器範本類型。可以是 ServerTemplateData 物件或範本 JSON 字串。
標記顏色	與狀況相關聯的顏色 (以便顯示)。
ValueSource	指出值的來源。 「static」表示該值由靜態常數定義。 「預設」表示該值是由預設設定定義。 「遠端」表示該值是由評估範本產生的設定定義。

getRemoteConfig(應用程式)

取得預設應用程式或特定應用程式的 RemoteConfig 服務。

呼叫 getRemoteConfig() 時無需引數即可存取預設應用程式的 RemoteConfig 服務，也可使用 getRemoteConfig(app) 形式呼叫，藉此存取與特定應用程式相關聯的 RemoteConfig 服務。

簽名：

export declare function getRemoteConfig(app?: App): RemoteConfig;

參數

參數	類型	說明
應用程式	應用程式	用於傳回 RemoteConfig 服務的選用應用程式。如未提供，系統會傳回預設的 RemoteConfig 服務。

傳回：

RemoteConfig

如未提供應用程式，或與提供應用程式相關聯的 RemoteConfig 服務，則預設的 RemoteConfig 服務。

範例 1

// Get the `RemoteConfig` service for the default app
const defaultRemoteConfig = getRemoteConfig();

範例 2

// Get the `RemoteConfig` service for a given app
const otherRemoteConfig = getRemoteConfig(otherApp);

預設值

定義應用程式內預設參數值的格式。

簽名：

export type DefaultConfig = {
    [key: string]: string | number | boolean;
};

評估情境

代表範本評估輸入信號。

簽名：

export type EvaluationContext = {
    randomizationId?: string;
};

ParameterValueType

代表遠端設定參數值資料類型的類型。如未指定，預設值為 STRING。

簽名：

export type ParameterValueType = 'STRING' | 'BOOLEAN' | 'NUMBER' | 'JSON';

遠端設定參數值

代表遠端設定參數值的類型。RemoteConfigParameterValue 可以是 ExplicitParameterValue 或 InAppDefaultValue。

簽名：

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

ServerTemplateDataType

代表可於 ServerTemplate 設定的遠端設定伺服器範本類型。可以是 ServerTemplateData 物件或範本 JSON 字串。

簽名：

export type ServerTemplateDataType = ServerTemplateData | string;

標記顏色

與狀況相關聯的顏色 (以便顯示)。

簽名：

export type TagColor = 'BLUE' | 'BROWN' | 'CYAN' | 'DEEP_ORANGE' | 'GREEN' | 'INDIGO' | 'LIME' | 'ORANGE' | 'PINK' | 'PURPLE' | 'TEAL';

值來源

表示值的來源。

• 「static」表示該值由靜態常數定義。
• 「預設」表示該值是由預設設定定義。
• 「遠端」表示該值是由評估範本產生的設定定義。

簽名：

export type ValueSource = 'static' | 'default' | 'remote';

PercentCondition 運算子

定義支援的百分比條件運算子。

簽名：

export declare enum PercentConditionOperator 

列舉成員

成員	值	說明
介於	"BETWEEN"	指定間隔內的目標百分位數，由下限和上限定義。下限為獨佔 (open) 邊界，而 micro_percent_range_upper_bound 是包含封閉式 (封閉) 的範圍。使用這個運算子的條件必須指定 microPercentRange。
GREATER_THAN	"GREATER_THAN"	目標百分位數大於目標百分比。使用這個運算子的條件必須指定 microPercent。
LESS_OR_EQUAL	"LESS_OR_EQUAL"	目標百分位數，小於或等於目標百分比。使用這個運算子的條件必須指定 microPercent。
不明	"UNKNOWN"	全部通用錯誤情況。