RemoteConfig đại diện cho mẫu Cấu hình từ xa.
Mẫu Cấu hình từ xa của dự án được đánh giá trong quá trình tìm nạp của mỗi phiên bản ứng dụng.
Giá trị giải quyết của một tham số được xác định như sau:
Với conditional values
tham chiếu đến conditions
true
cho phiên bản ứng dụng, giá trị được giải quyết của tham số là giá trị điều kiện name
sớm nhất trong conditions list
.
Ngược lại, nếu tham số có default value
thì giá trị được giải quyết sẽ được đặt thành giá trị mặc định.
Ngược lại, tham số này không có giá trị và bị loại bỏ khỏi kết quả mà phiên bản ứng dụng tìm nạp.
Ví dụ: giả sử chúng ta có khóa tham số fruit
, với giá trị mặc định pear
và sơ đồ con giá trị có {"is_ios": "apple", "is_in_20_percent": "banana"}
trong đó "is_ios"
và "is_20_percent"
là tên của các điều kiện theo thứ tự danh sách điều kiện. Giá trị của fruit
sẽ đánh giá apple
nếu is_ios
là đúng. Ngược lại, nếu is_in_20_percent
là true
, fruit
sẽ đánh giá là banana
và nếu is_ios
và is_in_20_percent
đều sai, fruit
sẽ đánh giá là pear
. Nếu không có giá trị mặc định nào được chỉ định và is_ios
và is_in_20_percent
đều sai thì sẽ không có giá trị nào cho fruit
được trả về từ máy chủ Cấu hình từ xa cho máy khách.
Khi mẫu Cấu hình từ xa của dự án đã được xuất bản thông qua lệnh gọi projects.updateRemoteConfig
thành công, khách hàng có thể tìm nạp các giá trị tham số này và hiển thị chúng cho người dùng.
Biểu diễn JSON |
---|
{ "conditions": [ { object ( |
Lĩnh vực | |
---|---|
conditions[] | Danh sách các điều kiện theo thứ tự ưu tiên giảm dần. Giá trị của các mục |
parameters | Ánh xạ các khóa tham số tới các giá trị mặc định tùy chọn và các giá trị điều kiện tùy chọn của chúng. Một đối tượng chứa danh sách các cặp |
version | Chỉ xuất ra, ngoại trừ |
parameterGroups | Ánh xạ tên nhóm tham số tới mô tả của chúng và các tham số được nhóm. Tên của nhóm có thể thay đổi nhưng phải là duy nhất giữa các nhóm trong cấu hình. Tên được giới hạn ở 256 ký tự và nhằm mục đích để con người có thể đọc được. Bất kỳ ký tự Unicode nào đều được phép. Các nhóm có một danh sách các tham số cho phép người dùng API nhóm các tham số được liên kết với cùng một tính năng hoặc chủ đề với nhau để tổ chức dễ dàng truy cập. Ví dụ: nhóm tham số có tên "Tìm kiếm V2" có thể có Một đối tượng chứa danh sách các cặp |
Điều kiện cấu hình từ xa
Một điều kiện nhắm mục tiêu một nhóm người dùng cụ thể. Danh sách các điều kiện này tạo nên một phần của đối tượng RemoteConfig.
Biểu diễn JSON |
---|
{
"name": string,
"expression": string,
"tagColor": enum ( |
Lĩnh vực | |
---|---|
name | Yêu cầu. Tên không trống và duy nhất của tình trạng này. |
expression | Yêu cầu. Logic của điều kiện này. Xem tài liệu về Biểu thức điều kiện để biết cú pháp dự kiến của trường này. |
tagColor | Không bắt buộc. Màu được liên kết với điều kiện này nhằm mục đích hiển thị trong Bảng điều khiển Firebase. Việc không chỉ định giá trị này hoặc có "CONDITION_DISPLAY_COLOR_UNSPECIFIED" sẽ khiến Bảng điều khiển chọn một màu tùy ý để liên kết với điều kiện. |
Tình trạngHiển thịMàu sắc
Danh sách các màu được liên kết với Điều kiện nhằm mục đích hiển thị.
Enum | |
---|---|
CONDITION_DISPLAY_COLOR_UNSPECIFIED | |
BLUE | Màu xanh da trời |
BROWN | Màu nâu |
CYAN | lục lam |
DEEP_ORANGE | hay còn gọi là "Cam đỏ" |
GREEN | Màu xanh lá |
INDIGO | xanh đậm |
LIME | Chanh xanh |
ORANGE | Quả cam |
PINK | Hồng |
PURPLE | Màu tím |
TEAL | màu xanh mòng két |
Tham số cấu hình từ xa
Giá trị tham số được liên kết với khóa tham số trong google.firebase.remoteconfig.v1.RemoteConfig.parameters
.
Tối thiểu phải có một mục nhập defaultValue
hoặc Giá conditionalValues
điều kiện để tham số có hiệu lực.
Biểu diễn JSON |
---|
{ "defaultValue": { object ( |
Lĩnh vực | |
---|---|
defaultValue | Tùy chọn - giá trị để đặt tham số khi không có điều kiện được đặt tên nào đánh giá là |
conditionalValues | Tùy chọn - bản đồ ( Một đối tượng chứa danh sách các cặp |
description | Không bắt buộc. Mô tả cho Thông số này. Độ dài của nó phải nhỏ hơn hoặc bằng 256 ký tự. Mô tả có thể chứa bất kỳ ký tự Unicode nào. |
valueType | Kiểu dữ liệu cho tất cả các giá trị của tham số này trong phiên bản hiện tại của mẫu. Mặc định là |
RemoteConfigParameterValue
Tài nguyên RemoteConfigParameterValue chứa giá trị mà tham số có thể có.
Biểu diễn JSON |
---|
{ // Union field |
Lĩnh vực | |
---|---|
Trường liên kết value_option . RemoteConfigParameterValue bao gồm một chuỗi (giá trị) hoặc boolean (use_in_app_default, được đặt thành true nếu có). value_option chỉ có thể là một trong những giá trị sau: | |
value | Giá trị chuỗi mà tham số được đặt thành. |
useInAppDefault | Nếu đúng, tham số này sẽ bị bỏ qua khỏi các giá trị tham số được trả về cho máy khách. |
personalizationValue | Giá trị động, dành riêng cho người dùng được tính khi tìm nạp cấu hình. |
Giá trị cá nhân hóa
Chứa thông tin cần thiết để lấy giá trị được cá nhân hóa.
Biểu diễn JSON |
---|
{ "personalizationId": string } |
Lĩnh vực | |
---|---|
personalizationId | Giá trị nhận dạng đại diện cho định nghĩa cá nhân hóa. Định nghĩa này được sử dụng để phân giải giá trị tại thời điểm tìm nạp cấu hình. Giá trị do hệ thống tạo ra này không nên được sửa đổi. |
Loại giá trị tham số
Các loại dữ liệu được chấp nhận cho các giá trị tham số.
Enum | |
---|---|
PARAMETER_VALUE_TYPE_UNSPECIFIED | Bắt tất cả các giá trị enum không được công nhận. |
STRING | Đại diện cho các giá trị Chuỗi. |
BOOLEAN | Đại diện cho các giá trị Boolean ("true" hoặc "false"). |
NUMBER | Đại diện cho cả giá trị số nguyên dương và âm và giá trị float. |
JSON | Đại diện cho các giá trị JSON. |
Nhóm thông số cấu hình từ xa
Một nhóm tham số được đặt tên. Việc nhóm các tham số chỉ nhằm mục đích quản lý và không ảnh hưởng đến việc tìm nạp các giá trị tham số phía máy khách.
Biểu diễn JSON |
---|
{
"description": string,
"parameters": {
string: {
object ( |
Lĩnh vực | |
---|---|
description | Không bắt buộc. Một mô tả cho nhóm. Độ dài của nó phải nhỏ hơn hoặc bằng 256 ký tự. Mô tả có thể chứa bất kỳ ký tự Unicode nào. |
parameters | Ánh xạ các khóa tham số tới các giá trị mặc định tùy chọn và các giá trị điều kiện tùy chọn cho các tham số thuộc nhóm này. Một tham số chỉ xuất hiện một lần trên mỗi RemoteConfig: một tham số chưa được nhóm xuất hiện ở cấp cao nhất; một tham số được tổ chức trong một nhóm sẽ xuất hiện trong bản đồ tham số của nhóm đó. Một đối tượng chứa danh sách các cặp |