RemoteConfig

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 (RemoteConfigCondition)
    }
  ],
  "parameters": {
    string: {
      object (RemoteConfigParameter)
    },
    ...
  },
  "version": {
    object (Version)
  },
  "parameterGroups": {
    string: {
      object (RemoteConfigParameterGroup)
    },
    ...
  }
}
領域
conditions[]

object ( RemoteConfigCondition )

依優先順序降序排列的條件清單。

google.firebase.remoteconfig.v1.RemoteConfigCondition.name條目的值必須是唯一的。

parameters

map (key: string, value: object ( RemoteConfigParameter ))

參數鍵與其可選預設值和可選條件值的對應。

包含"key": value對。範例： { "name": "wrench", "mass": "1.3kg", "count": "3" } 。

version

object ( Version )

僅輸出，版本description除外。與模板的特定版本關聯的元資料。版本的描述欄位可以在projects.updateRemoteConfig呼叫中指定。

parameterGroups

map (key: string, value: object ( RemoteConfigParameterGroup ))

參數組名稱與其描述和分組參數的對應。群組的名稱是可變的，但在配置中的群組中必須是唯一的。該名稱限制為 256 個字符，旨在便於人類閱讀。允許使用任何 Unicode 字元。

群組具有參數列表，允許 API 使用者將與相同功能或主題關聯的參數分組在一起，以便於組織存取。

例如，名稱為「Search V2」的參數組可能具有「新行動搜尋視圖」 description ，並包含新搜尋佈局和字體的參數。

包含"key": value對。範例： { "name": "wrench", "mass": "1.3kg", "count": "3" } 。

遠端配置條件

針對特定使用者群組的條件。這些條件的清單構成了 RemoteConfig 物件的一部分。

JSON 表示
{
  "name": string,
  "expression": string,
  "tagColor": enum (ConditionDisplayColor)
}
領域
name

string

必需的。此條件的非空且唯一的名稱。

expression

string

必需的。這個條件的邏輯。

有關該欄位的預期語法，請參閱有關條件表達式的文件。

tagColor

enum ( ConditionDisplayColor )

選修的。與此條件關聯的顏色，用於在 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 (RemoteConfigParameterValue)
  },
  "conditionalValues": {
    string: {
      object (RemoteConfigParameterValue)
    },
    ...
  },
  "description": string,
  "valueType": enum (ParameterValueType)
}
領域
defaultValue

object ( RemoteConfigParameterValue )

可選 - 當沒有指定條件評估為true時，將參數設為的值。

conditionalValues

map (key: string, value: object ( RemoteConfigParameterValue ))

可選 - （ condition name ，值）映射。最高優先權的條件名稱（RemoteConfig 條件清單中第一個列出的條件名稱）決定此參數的值。

包含"key": value對。範例： { "name": "wrench", "mass": "1.3kg", "count": "3" } 。

description

string

選修的。此參數的描述。其長度必須小於或等於 256 個字元。描述可以包含任何 Unicode 字元。

valueType

enum ( ParameterValueType )

目前版本範本中此參數的所有值的資料類型。如果未指定，則預設為ParameterValueType.STRING 。

遠端配置參數值

RemoteConfigParameterValue 資源包含參數可能具有的值。

JSON 表示
{

  // Union field value_option can be only one of the following:
  "value": string,
  "useInAppDefault": boolean,
  "personalizationValue": {
    object (PersonalizationValue)
  }
  // End of list of possible types for union field value_option.
}
領域
聯合欄位value_option 。 RemoteConfigParameterValue 由字串（值）或布林值（use_in_app_default，如果適用，設定為 true）組成。 value_option只能是以下之一：
value

string

參數設定為的字串值。

useInAppDefault

boolean

如果為 true，則從傳回給客戶端的參數值中省略該參數。

personalizationValue

object ( PersonalizationValue )

取得配置時計算的動態的、使用者特定的值。

個性化價值

包含獲取個人化值所需的資訊。

JSON 表示
{
  "personalizationId": string
}
領域
personalizationId

string

代表個性化定義的識別符。此定義用於解析配置取得時的值。不應修改該系統產生的值。

參數值類型

參數值接受的資料型態。

列舉
PARAMETER_VALUE_TYPE_UNSPECIFIED捕獲無法識別的枚舉值。
STRING表示字串值。
BOOLEAN表示布林值（“true”或“false”）。
NUMBER表示正整數和負整數以及浮點數值。
JSON表示 JSON 值。

遠端配置參數組

一組命名參數。參數分組僅用於管理目的，不影響客戶端取得參數值。

JSON 表示
{
  "description": string,
  "parameters": {
    string: {
      object (RemoteConfigParameter)
    },
    ...
  }
}
領域
description

string

選修的。對組的描述。其長度必須小於或等於 256 個字元。描述可以包含任何 Unicode 字元。

parameters

map (key: string, value: object ( RemoteConfigParameter ))

參數鍵到屬於該組的參數的可選預設值和可選條件值的對應。每個 RemoteConfig 中的參數僅出現一次：未分組的參數出現在頂層；組內組織的參數出現在其組的參數映射中。

包含"key": value對。範例： { "name": "wrench", "mass": "1.3kg", "count": "3" } 。