firebase-admin.remote-config package

Firebase Remote Config。

函数

函数	说明
getRemoteConfig(应用)	获取默认应用或指定应用的 RemoteConfig 服务。无需参数即可调用 getRemoteConfig()，以访问默认应用的 RemoteConfig 服务；也可作为 getRemoteConfig(app) 调用与特定应用关联的 RemoteConfig 服务。

类

类	说明
RemoteConfig	Firebase RemoteConfig 服务接口。

枚举

枚举	说明
PercentConditionOperator	定义百分比条件支持的运算符。

接口

接口	说明
AndCondition	表示如果所有条件均为 true，则评估结果为 true 的条件集合。
显式参数值	表示显式参数值的接口。
GetServerTemplateOptions	表示在实例化 ServerTemplate 时可以使用的可选参数。
InAppDefaultValue	表示应用内默认值的接口。
InitServerTemplateOptions	表示同步实例化 ServerTemplate 时可以使用的可选参数。
ListVersionsOptions	表示 Remote Config 列出版本操作选项的接口。
ListVersionsResult	表示 Remote Config 模板版本列表的界面。
MicroPercentRange	表示要定位的百分位数限制（以微百分比为单位）。该值必须在 [0 到 100000000] 的范围内
NamedCondition	表示数据平面中的 Remote Config 条件。一项条件定位的是一组特定的用户。这些条件的列表是 Remote Config 模板的一部分。
OneOfCondition	表示可以是多种类型之一的条件。系统只会处理第一个定义的字段。
OrCondition	表示评估结果为 true 的条件集合（如有）。
PercentCondition	表示将实例伪随机百分位数与给定上限进行比较的条件。
RemoteConfigCondition	表示 Remote Config 条件的界面。一项条件定位的是一组特定的用户。这些条件的列表构成了 Remote Config 模板的一部分。
RemoteConfigParameters	表示 Remote Config 参数的接口。为了让该参数发挥作用，至少必须存在 defaultValue 或 conditionalValues 条目。
RemoteConfigParametersGroup	表示 Remote Config 参数组的界面。分组参数仅用于管理目的，不会影响在客户端提取参数值。
RemoteConfigTemplate	表示 Remote Config 客户端模板。
RemoteConfigUser	表示 Remote Config 用户的界面。
ServerConfig	表示通过评估服务器模板生成的配置。
ServerTemplate	表示 Remote Config 服务器模板的有状态抽象。
ServerTemplateData	表示 Remote Config 服务器模板中的数据。
值	使用元数据和类型安全的 getter 来封装参数值。类型安全的 getter 使应用逻辑不会远程更改参数名称和类型。
版本	表示 Remote Config 模板版本的界面。仅输出（版本说明除外）。包含有关 Remote Config 模板特定版本的元数据。所有字段均是在发布指定的 Remote Config 模板时设置的。版本的说明字段可以在 publishTemplate 调用中指定。

类型别名

类型别名	说明
DefaultConfig	定义应用内默认参数值的格式。
EvaluationContext	表示模板评估输入信号。
参数值类型	表示 Remote Config 参数值数据类型的类型。如果未指定，则默认为 STRING。
RemoteConfigParameterValue	表示 Remote Config 参数值的类型。RemoteConfigParameterValue 可以是 ExplicitParameterValue，也可以是 InAppDefaultValue。
ServerTemplateDataType	表示可在 ServerTemplate 上设置的 Remote Config 服务器模板的类型。这可以是 ServerTemplateData 对象或模板 JSON 字符串。
标记颜色	为显示目的而与条件相关联的颜色。
值来源	表示值的来源。 “static”表示值由静态常量定义。 “默认”表示该值是由默认配置定义的。 “remote”表示该值由评估模板生成的配置定义。

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);

DefaultConfig

定义应用内默认参数值的格式。

签名：

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

EvaluationContext

表示模板评估输入信号。

签名：

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

ParameterValueType

表示 Remote Config 参数值数据类型的类型。如果未指定，则默认为 STRING。

签名：

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

RemoteConfig 参数值

表示 Remote Config 参数值的类型。RemoteConfigParameterValue 可以是 ExplicitParameterValue 或 InAppDefaultValue。

签名：

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

服务器模板数据类型

表示可在 ServerTemplate 上设置的 Remote Config 服务器模板的类型。这可以是 ServerTemplateData 对象或模板 JSON 字符串。

签名：

export type ServerTemplateDataType = ServerTemplateData | string;

标签颜色

为显示目的而与条件相关联的颜色。

签名：

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

值源

表示值的来源。

• “static”表示值由静态常量定义。
• “默认”表示该值是由默认配置定义的。
• “remote”表示该值由评估模板生成的配置定义。

签名：

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

PercentConditionOperator

定义百分比条件支持的运算符。

签名：

export declare enum PercentConditionOperator 

枚举成员

成员	值	说明
BETWEEN	"BETWEEN"	在由下限和上限定义的间隔内的目标百分位。下限是独占（开放）边界，micro_percent_range_upper_bound 是包含（封闭）边界。使用此运算符的条件必须指定 microPercentRange。
GREATER_THAN	"GREATER_THAN"	目标百分位数大于目标百分比。使用此运算符的条件必须指定 microPercent。
LESS_OR_EQUAL	"LESS_OR_EQUAL"	小于或等于目标百分比的目标百分位数。使用此运算符的条件必须指定 microPercent。
未知	"UNKNOWN"	通用错误情形。