RemoteConfig 代表远程配置模板。
项目的远程配置模板在每个应用程序实例的获取期间进行评估。
参数的解析值确定如下:
给定引用应用程序实例的true
conditions
conditional values
,参数的解析值是conditions list
中name
最早的条件值。
否则,如果参数有default value
,则解析值将设置为默认值。
否则,该参数没有值,并且会从应用程序实例获取的结果中省略。
例如,假设我们有参数键fruit
,默认值pear
和条件值子图{"is_ios": "apple", "is_in_20_percent": "banana"}
其中"is_ios"
和"is_20_percent"
是有序条件中的条件名称条件清单。如果is_ios
为 true,则fruit
的值将评估为apple
。否则,如果is_in_20_percent
为true
, fruit
将计算为banana
,如果is_ios
和is_in_20_percent
均为 false ,则fruit
将计算为pear
。如果未指定默认值,并且is_ios
和is_in_20_percent
均为 false,则远程配置服务器不会向客户端返回fruit
值。
通过成功的projects.updateRemoteConfig
调用发布项目的远程配置模板后,客户端可以获取这些参数值并将其显示给用户。
JSON 表示 |
---|
{ "conditions": [ { object ( |
领域 | |
---|---|
conditions[] | 按优先级降序排列的条件列表。 |
parameters | 参数键与其可选默认值和可选条件值的映射。 包含 |
version | 仅输出,版本 |
parameterGroups | 参数组名称与其描述和分组参数的映射。组的名称是可变的,但在配置中的组中必须是唯一的。该名称限制为 256 个字符,旨在便于人类阅读。允许使用任何 Unicode 字符。 组有一个参数列表,允许 API 用户将与相同功能或主题关联的参数分组在一起,以便于组织访问。 例如,名称为“Search V2”的参数组可能具有“新移动搜索视图” 包含 |
远程配置条件
针对特定用户组的条件。这些条件的列表构成了 RemoteConfig 对象的一部分。
JSON 表示 |
---|
{
"name": string,
"expression": string,
"tagColor": enum ( |
领域 | |
---|---|
name | 必需的。此条件的非空且唯一的名称。 |
expression | 必需的。这个条件的逻辑。 有关该字段的预期语法,请参阅有关条件表达式的文档。 |
tagColor | 选修的。与此条件关联的颜色,用于在 Firebase 控制台中显示。未指定此值或具有“CONDITION_DISPLAY_COLOR_UNSPECIFIED”会导致控制台选择任意颜色与条件关联。 |
条件显示颜色
与用于显示目的的条件关联的颜色列表。
枚举 | |
---|---|
CONDITION_DISPLAY_COLOR_UNSPECIFIED | |
BLUE | 蓝色的 |
BROWN | 棕色的 |
CYAN | 青色 |
DEEP_ORANGE | 又名“红橙” |
GREEN | 绿色的 |
INDIGO | 靛青 |
LIME | 酸橙 |
ORANGE | 橙子 |
PINK | 粉色的 |
PURPLE | 紫色的 |
TEAL | 青色 |
远程配置参数
与google.firebase.remoteconfig.v1.RemoteConfig.parameters
中的参数键关联的参数值。
至少应该存在defaultValue
或conditionalValues
条目才能使参数产生任何效果。
JSON 表示 |
---|
{ "defaultValue": { object ( |
领域 | |
---|---|
defaultValue | 可选 - 当没有指定条件评估为 |
conditionalValues | 可选 - ( 包含 |
description | 选修的。该参数的描述。其长度必须小于或等于 256 个字符。描述可以包含任何 Unicode 字符。 |
valueType | 当前版本模板中此参数的所有值的数据类型。如果未指定,则默认为 |
远程配置参数值
RemoteConfigParameterValue 资源包含参数可能具有的值。
JSON 表示 |
---|
{ // Union field |
领域 | |
---|---|
联合字段value_option 。 RemoteConfigParameterValue 由字符串(值)或布尔值(use_in_app_default,如果适用,设置为 true)组成。 value_option 只能是以下之一: | |
value | 参数设置为的字符串值。 |
useInAppDefault | 如果为 true,则从返回给客户端的参数值中省略该参数。 |
personalizationValue | 获取配置时计算的动态的、用户特定的值。 |
个性化价值
包含获取个性化值所需的信息。
JSON 表示 |
---|
{ "personalizationId": string } |
领域 | |
---|---|
personalizationId | 代表个性化定义的标识符。此定义用于解析配置获取时的值。不应修改该系统生成的值。 |
参数值类型
参数值接受的数据类型。
枚举 | |
---|---|
PARAMETER_VALUE_TYPE_UNSPECIFIED | 捕获无法识别的枚举值。 |
STRING | 表示字符串值。 |
BOOLEAN | 表示布尔值(“true”或“false”)。 |
NUMBER | 表示正整数和负整数以及浮点值。 |
JSON | 表示 JSON 值。 |
远程配置参数组
一组命名参数。参数分组仅用于管理目的,不影响客户端获取参数值。
JSON 表示 |
---|
{
"description": string,
"parameters": {
string: {
object ( |
领域 | |
---|---|
description | 选修的。对组的描述。其长度必须小于或等于 256 个字符。描述可以包含任何 Unicode 字符。 |
parameters | 参数键到属于该组的参数的可选默认值和可选条件值的映射。每个 RemoteConfig 中的参数仅出现一次:未分组的参数出现在顶层;组内组织的参数出现在其组的参数映射中。 包含 |