firebase-admin.remote-config package

Cấu hình từ xa Firebase.

Hàm

Chức năng Mô tả
getRemoteConfig(ứng dụng) Lấy 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ần đối số để truy cập vào dịch vụ RemoteConfig của ứng dụng mặc định hoặc getRemoteConfig(app) để truy cập vào dịch vụ RemoteConfig liên kết với một ứng dụng cụ thể.

Hạng

Hạng Mô tả
Cấu hình từ xa Giao diện dịch vụ Firebase RemoteConfig.

Bảng liệt kê

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

Giao diện

Giao diện Mô tả
AndCondition Biểu thị một tập hợp các điều kiện sẽ đánh giá là true nếu tất cả đều là true.
explicitParameterValue Giao diện biểu thị một giá trị tham số rõ ràng.
GetServerTemplateOptions Biểu thị các đối số không bắt buộc có thể dùng khi tạo thực thể của ServerTemplate.
Giá trị 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 Giao diện biểu thị các tuỳ chọn cho thao tác về phiên bản 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.
MicroPercentRange Biểu thị giới hạn phân vị để nhắm mục tiêu tính theo phần trăm một phần triệu. Giá trị phải nằm trong khoảng [0 và 100000000]
NamedCondition Biểu thị một điều kiện Cấu hình từ xa trong tầng 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 Đại diện cho 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 đã xác định đầu tiên.
OrCondition Biểu thị một tập hợp các điều kiện sẽ đánh giá là true nếu có điều kiện nào là true.
PercentCondition Đại diện cho 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ị đ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 bao gồm một phần của mẫu Cấu hình từ xa.
RemoteConfigParameter Giao diện biểu thị thông số Cấu hình từ xa. Ở mức tối thiểu, tham số phải có mục defaultValue hoặc conditionalValues để tham số này có hiệu lực.
RemoteConfigParameterGroup Giao diện biểu thị một 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 các 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.
Cấu hình máy chủ Biểu thị cấu hình được tạo bằng cách đánh giá mẫu máy chủ.
Mẫu máy chủ Đại diện cho một bản tóm tắt trạng thái cho mẫu máy chủ Cấu hình từ xa.
Dữ liệu mẫu máy chủ Biểu thị dữ liệu trong mẫu máy chủ Cấu hình từ xa.
Giá trị Gói giá trị tham số bằng siêu dữ liệu và phương thức getter an toàn về loại.Phương thức getter an toàn về kiểu tách biệt logic ứng dụng khỏi các thay đổi từ xa đối với tên và kiểu tham số.
Phiên bản Giao diện biểu thị phiên bản mẫu Cấu hình từ xa. Chỉ có đầu ra, ngoại trừ phần 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 đều đượ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.

Loại bí danh

Loại 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 của đánh giá mẫu.
ParameterValueType 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 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 Đại diện cho loại mẫu máy chủ Cấu hình từ xa có thể đặt trên ServerTemplate. Đây có thể là một đối tượng ServerTemplateData hoặc chuỗi JSON của mẫu.
TagColor Màu được liên kết với các điều kiện cho mục đích hiển thị.
Nguồn giá trị Cho biết nguồn của một giá trị.
  • "static" cho biết giá trị được xác định bằng một hằng số tĩnh.
  • "default" cho biết giá trị đã được xác định theo cấu hình mặc định.
  • "remote" cho biết giá trị được xác định bởi cấu hình tạo ra bằng cách đánh giá một mẫu.

getRemoteConfig(ứng dụng)

Lấy dịch vụ RemoteConfig cho ứng dụng mặc định hoặc một ứng dụng cụ thể.

Có thể gọi getRemoteConfig() mà không có đối số để truy cập vào dịch vụ RemoteConfig của ứng dụng mặc định hoặc dưới dạng getRemoteConfig(app) để truy cập vào 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:

Cấu hình từ xa

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 được 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 của đánh giá mẫu.

Chữ ký:

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

Loại giá trị tham 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 không chỉ định.

Chữ ký:

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

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.

Chữ ký:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

Loại dữ liệu mẫu máy chủ

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

Chữ ký:

export type ServerTemplateDataType = ServerTemplateData | string;

Màu thẻ

Màu được 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ị.

  • "static" cho biết giá trị được xác định bằng một hằng số tĩnh.
  • "default" cho biết giá trị đã được xác định theo cấu hình mặc định.
  • "remote" cho biết giá trị được xác định bởi cấu hình tạo ra bằng cách đánh giá một mẫu.

Chữ ký:

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

%ConditionOperator

Xác định các toán tử được hỗ trợ cho đ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 nằm trong khoảng thời gian 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 hàm (đóng). Điều kiện sử dụng toán tử này phải chỉ định microPercentRange.
GREATER_ hơn "GREATER_THAN" Phân vị mục tiêu lớn hơn tỷ lệ phần trăm mục tiêu. Điều kiện sử dụng toán tử này phải chỉ định microPercent.
ÍT_HOẶC_EQUAL "LESS_OR_EQUAL" Phân vị mục tiêu nhỏ hơn hoặc bằng tỷ lệ phần trăm mục tiêu. Đ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 chung.