firebase-admin.remote-config package

Cấu hình từ xa Firebase.

Hàm

Chức năng Mô tả
getRemoteConfig(app) Nhận dịch vụ RemoteConfig cho ứng dụng mặc định hoặc một ứng dụng nhất định.getRemoteConfig() có thể được gọi mà không cần đối số để truy cập dịch vụ RemoteConfig của ứng dụng mặc định hoặc dưới dạng getRemoteConfig(app) để truy cập dịch vụ RemoteConfig liên kết với một ứng dụng cụ thể.

Lớp học

Hạng Mô tả
RemoteConfig Giao diện dịch vụ Firebase RemoteConfig.

Liệt kê

Liệt kê Mô tả
PercentConditionOperator Xác định các toán tử được hỗ trợ cho các điều kiện phần trăm.

Giao diện

Giao diện Mô tả
Tình trạng và điều kiện Biểu thị một tập hợp các điều kiện được đánh giá là true nếu tất cả đều đúng.
explicitParametersValue Giao diện biểu thị một giá trị tham số rõ ràng.
GetServerTemplateOptions Đại diện cho các đối số không bắt buộc có thể dùng khi tạo thực thể ServerTemplate.
InAppDefaultValue Giao diện biểu thị một giá trị mặc định trong ứng dụng.
InitServerTemplateOptions Biểu thị các đối số không bắt buộc có thể dùng khi tạo thực thể ServerTemplate một cách đồng bộ.
ListVersionsOptions (Tuỳ chọn) Giao diện biểu thị các tuỳ chọn cho thao tác trên các phiên bản trong danh sách Cấu hình từ xa.
ListVersionsResult Giao diện biểu thị danh sách phiên bản mẫu Cấu hình từ xa.
Phạm vi phần trăm Biểu thị giới hạn của số phần trăm cần nhắm mục tiêu theo phần trăm vi mô. Giá trị phải nằm trong khoảng [0 và 100000000]
NamedCondition Đại diện cho một điều kiện Cấu hình từ xa trong biểu đồ dữ liệu. Một điều kiện nhắm đến một nhóm người dùng cụ thể. Danh sách các điều kiện này bao gồm một phần của mẫu Cấu hình từ xa.
OneOfCondition Biểu thị một điều kiện có thể thuộc một trong nhiều loại. Hệ thống chỉ xử lý trường được xác định đầu tiên.
OrCondition Biểu thị một tập hợp các điều kiện được đánh giá là true (đúng) nếu có (true).
PercentCondition Biểu thị một điều kiện so sánh phân vị giả ngẫu nhiên của thực thể với một giới hạn nhất định.
RemoteConfigCondition Giao diện biểu thị một điều kiện Cấu hình từ xa. Một điều kiện nhắm đến 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 mẫu Cấu hình từ xa.
RemoteConfig thông số Giao diện đại diện cho thông số Cấu hình từ xa. Ở mức tối thiểu, bạn phải có một mục nhập defaultValue hoặc conditionalValues để tham số có hiệu lực.
RemoteConfigParameterGroup Giao diện đại diện cho nhóm thông số Cấu hình từ xa. Việc nhóm các thông số chỉ dành cho mục đích quản lý và không ảnh hưởng đến việc tìm nạp giá trị thông số phía máy khách.
RemoteConfigTemplate Đại diện cho một mẫu ứng dụng Cấu hình từ xa.
RemoteConfigUser Giao diện đại diện cho người dùng Cấu hình từ xa.
ServerConfig Biểu thị cấu hình được tạo bằng cách đánh giá một mẫu máy chủ.
Mẫu máy chủ Đại diện cho một mô hình trừu tượng trạng thái cho mẫu máy chủ Cấu hình từ xa.
ServerTemplateData Biểu thị dữ liệu trong mẫu máy chủ Cấu hình từ xa.
Giá trị Gói một giá trị tham số bằng siêu dữ liệu và phương thức getter an toàn về kiểu.Phương thức getter an toàn về kiểu sẽ giúp áp dụng logic ứng dụng từ các thay đổi từ xa đến tên và kiểu của tham số.
Phiên bản Giao diện đại diện cho phiên bản mẫu Cấu hình từ xa. Chỉ có đầu ra, ngoại trừ nội dung mô tả phiên bản. Chứa siêu dữ liệu về một phiên bản cụ thể của mẫu Cấu hình từ xa. Tất cả các trường được đặt tại thời điểm xuất bản mẫu Cấu hình từ xa đã chỉ định. Bạn có thể chỉ định trường mô tả của một phiên bản trong lệnh gọi publishTemplate.

Nhập bí danh

Nhập bí danh Mô tả
DefaultConfig Xác định định dạng cho các giá trị thông số mặc định trong ứng dụng.
Đánh giáContext Biểu thị các tín hiệu đầu vào cho việc đánh giá mẫu.
Tham số giá trị Loại đại diện cho loại dữ liệu giá trị thông số Cấu hình từ xa. Giá trị mặc định là STRING nếu bạn không chỉ định.
RemoteConfigParameterValue Loại đại diện cho giá trị thông số Cấu hình từ xa. RemoteConfigParameterValue có thể là ExplicitParameterValue hoặc InAppDefaultValue.
ServerTemplateDataType Biểu thị loại mẫu máy chủ Cấu hình từ xa có thể đặt trên ServerTemplate. Đây có thể là đối tượng ServerTemplateData hoặc chuỗi JSON mẫu.
TagColor Màu liên kết với các điều kiện cho mục đích hiển thị.
ValueSource Cho biết nguồn của một giá trị.
  • "tĩnh" cho biết giá trị được xác định bởi một hằng số tĩnh.
  • "mặc định" cho biết giá trị được xác định theo cấu hình mặc định.
  • "điều khiển từ xa" cho biết giá trị được xác định bởi cấu hình được tạo ra bằng cách đánh giá một mẫu.

getRemoteConfig(ứng dụng)

Nhận dịch vụ RemoteConfig cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

getRemoteConfig() có thể được gọi mà không có đối số để truy cập dịch vụ RemoteConfig của ứng dụng mặc định hoặc dưới dạng getRemoteConfig(app) để truy cập dịch vụ RemoteConfig liên kết với một ứng dụng cụ thể.

Chữ ký:

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

Thông số

Thông số Loại Mô tả
ứng dụng Ứng dụng Ứng dụng không bắt buộc để trả về dịch vụ RemoteConfig. Nếu không được cung cấp, dịch vụ RemoteConfig mặc định sẽ được trả về.

Trường hợp trả lại hàng:

RemoteConfig

Dịch vụ RemoteConfig mặc định nếu không có ứng dụng nào được cung cấp hoặc dịch vụ RemoteConfig liên kết với ứng dụng đã cung cấp.

Ví dụ 1

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

Ví dụ 2

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

Cấu hình mặc định

Xác định định dạng cho các giá trị thông số mặc định trong ứng dụng.

Chữ ký:

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

Ngữ cảnh đánh giá

Biểu thị các tín hiệu đầu vào cho việc đánh giá mẫu.

Chữ ký:

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

Loại giá trị thông số

Loại đại diện cho loại dữ liệu giá trị thông số Cấu hình từ xa. Giá trị mặc định là STRING nếu bạn không chỉ định.

Chữ ký:

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

Giá trị thông số cấu hình từ xa

Loại đại diện cho giá trị thông số Cấu hình từ xa. RemoteConfigParameterValue có thể là ExplicitParameterValue hoặc InAppDefaultValue.

Chữ ký:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

Kiểu dữ liệu mẫu máy chủ

Biểu thị loại mẫu máy chủ Cấu hình từ xa có thể đặt trên ServerTemplate. Đây có thể là đối tượng ServerTemplateData hoặc chuỗi JSON mẫu.

Chữ ký:

export type ServerTemplateDataType = ServerTemplateData | string;

Màu thẻ

Màu liên kết với các điều kiện cho mục đích hiển thị.

Chữ ký:

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

Nguồn giá trị

Cho biết nguồn của một giá trị.

  • "tĩnh" cho biết giá trị được xác định bởi một hằng số tĩnh.
  • "mặc định" cho biết giá trị được xác định theo cấu hình mặc định.
  • "điều khiển từ xa" cho biết giá trị được xác định bởi cấu hình được tạo ra bằng cách đánh giá một mẫu.

Chữ ký:

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

PercentConditionOperator

Xác định các toán tử được hỗ trợ cho các điều kiện phần trăm.

Chữ ký:

export declare enum PercentConditionOperator 

Thành viên liệt kê

Thành viên Giá trị Mô tả
BETWEEN "BETWEEN" Phân vị mục tiêu trong một khoảng được xác định bởi giới hạn dưới và giới hạn trên. Giới hạn dưới là giới hạn độc quyền (mở) và giới hạn micro_percent_range_upper_bound là giới hạn bao gồm (đóng). Một điều kiện sử dụng toán tử này phải chỉ định microPercentPhạm vi.
Hàm GREATER_THAN "GREATER_THAN" Phân vị mục tiêu lớn hơn tỷ lệ phần trăm mục tiêu. Một điều kiện sử dụng toán tử này phải chỉ định MicroPercent.
ÍT_HOẶC_ĐƯỢC_TRƯỚC "LESS_OR_EQUAL" Tỷ lệ phần trăm mục tiêu nhỏ hơn hoặc bằng tỷ lệ phần trăm mục tiêu. Một điều kiện sử dụng toán tử này phải chỉ định MicroPercent.
KHÔNG XÁC ĐỊNH "UNKNOWN" Trường hợp lỗi toàn diện.