firebase-admin.remote-config package

menggunakan Firebase Remote Config.

Functions

Fungsi Deskripsi
getRemoteConfig(aplikasi) Mendapatkan layanan RemoteConfig untuk aplikasi default atau aplikasi tertentu.getRemoteConfig() dapat dipanggil tanpa argumen untuk mengakses layanan RemoteConfig aplikasi default atau sebagai getRemoteConfig(app) untuk mengakses layanan RemoteConfig yang terkait dengan aplikasi tertentu.

Kelas

Class Deskripsi
RemoteConfig Antarmuka layanan RemoteConfig Firebase.

Enumeration

Enumerasi Deskripsi
PercentConditionOperator Menentukan operator yang didukung untuk kondisi persen.

Antarmuka

Antarmuka Deskripsi
AndCondition Mewakili kumpulan kondisi yang bernilai benar jika semua bernilai benar.
EksplisitParameterValue Antarmuka yang mewakili nilai parameter eksplisit.
GetServerTemplateOptions Mewakili argumen opsional yang dapat digunakan saat membuat instance ServerTemplate.
InAppDefaultValue Antarmuka yang mewakili nilai default dalam aplikasi.
InitServerTemplateOptions Mewakili argumen opsional yang dapat digunakan saat membuat instance ServerTemplate secara sinkron.
ListVersionsOptions Antarmuka yang mewakili opsi untuk operasi versi daftar Remote Config.
ListVersionsResult Antarmuka yang menampilkan daftar versi template Remote Config.
MicroPercentRange Mewakili batas persentil untuk ditargetkan dalam persen mikro. Nilai harus dalam rentang [0 dan 100000000]
NamedCondition Merepresentasikan kondisi Remote Config di dataplane. Kondisi menargetkan grup pengguna tertentu. Daftar kondisi ini merupakan bagian dari template Remote Config.
OneOfCondition Merepresentasikan kondisi yang mungkin berupa salah satu dari beberapa jenis. Hanya kolom pertama yang ditentukan yang akan diproses.
OrCondition Merepresentasikan kumpulan kondisi yang bernilai benar jika ada yang benar.
PercentCondition Mewakili kondisi yang membandingkan persentil pseudo-random instance dengan batas yang diberikan.
RemoteConfigCondition Antarmuka yang mewakili kondisi Remote Config. Kondisi menargetkan grup pengguna tertentu. Daftar kondisi ini merupakan bagian dari template Remote Config.
RemoteConfigParameter Antarmuka yang mewakili parameter Remote Config. Setidaknya, entri defaultValue atau conditionalValues harus ada agar parameter dapat berfungsi.
RemoteConfigParameterGroup Antarmuka yang mewakili grup parameter Remote Config. Pengelompokan parameter hanya untuk tujuan pengelolaan dan tidak memengaruhi pengambilan nilai parameter sisi klien.
RemoteConfigTemplate Mewakili template klien Remote Config.
RemoteConfigUser Antarmuka yang mewakili pengguna Remote Config.
ServerConfig Mewakili konfigurasi yang dihasilkan dengan mengevaluasi template server.
ServerTemplate Merepresentasikan abstraksi stateful untuk template server Remote Config.
ServerTemplateData Mewakili data dalam template server Remote Config.
Value Menggabungkan nilai parameter dengan metadata dan pengambil yang aman.Pengambil jenis yang aman mengisolasi logika aplikasi dari perubahan jarak jauh ke nama dan jenis parameter.
Version Antarmuka yang mewakili versi template Remote Config. Hanya output, kecuali untuk deskripsi versi. Berisi metadata tentang versi template Remote Config tertentu. Semua kolom ditetapkan pada saat template Remote Config yang ditentukan dipublikasikan. Kolom deskripsi versi dapat ditentukan dalam panggilan publishTemplate.

Ketik Alias

Ketik Alias Deskripsi
DefaultConfig Menentukan format untuk parameter value default dalam aplikasi.
EvaluationContext Menampilkan sinyal input evaluasi template.
ParameterValueType Jenis yang mewakili jenis data nilai parameter Remote Config. Setelan defaultnya adalah STRING jika tidak ditentukan.
RemoteConfigParameterValue Jenis yang mewakili nilai parameter Remote Config. RemoteConfigParameterValue dapat berupa ExplicitParameterValue atau InAppDefaultValue.
ServerTemplateDataType Merepresentasikan jenis template server Remote Config yang dapat ditetapkan di ServerTemplate. Ini dapat berupa objek ServerTemplateData atau string JSON template.
TagColor Warna yang dikaitkan dengan kondisi untuk tujuan tampilan.
ValueSource Menunjukkan sumber nilai.
  • "statis" menunjukkan bahwa nilai didefinisikan oleh konstanta statis.
  • "default" menunjukkan bahwa nilai yang ditetapkan oleh konfigurasi default.
  • "jarak jauh" menunjukkan nilai yang ditetapkan oleh konfigurasi yang dihasilkan dengan mengevaluasi template.

getRemoteConfig(aplikasi)

Mendapatkan layanan RemoteConfig untuk aplikasi default atau aplikasi tertentu.

getRemoteConfig() dapat dipanggil tanpa argumen untuk mengakses layanan RemoteConfig aplikasi default atau sebagai getRemoteConfig(app) untuk mengakses layanan RemoteConfig yang terkait dengan aplikasi tertentu.

Tanda Tangan:

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

Parameter

Parameter Jenis Deskripsi
aplikasi Aplikasi Aplikasi opsional yang akan menampilkan layanan RemoteConfig. Jika tidak diberikan, layanan RemoteConfig default akan ditampilkan.

Hasil:

RemoteConfig

Layanan RemoteConfig default jika tidak ada aplikasi yang disediakan, atau layanan RemoteConfig yang dikaitkan dengan aplikasi yang disediakan.

Contoh 1

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

Contoh 2

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

DefaultConfig

Menentukan format untuk parameter value default dalam aplikasi.

Tanda Tangan:

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

EvaluasiContext

Menampilkan sinyal input evaluasi template.

Tanda Tangan:

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

ParameterValueType

Jenis yang mewakili jenis data nilai parameter Remote Config. Setelan defaultnya adalah STRING jika tidak ditentukan.

Tanda Tangan:

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

RemoteConfigParameterValue

Jenis yang mewakili nilai parameter Remote Config. RemoteConfigParameterValue dapat berupa ExplicitParameterValue atau InAppDefaultValue.

Tanda Tangan:

export type RemoteConfigParameterValue = ExplicitParameterValue | InAppDefaultValue;

ServerTemplateDataType

Merepresentasikan jenis template server Remote Config yang dapat ditetapkan di ServerTemplate. Ini dapat berupa objek ServerTemplateData atau string JSON template.

Tanda Tangan:

export type ServerTemplateDataType = ServerTemplateData | string;

WarnaTag

Warna yang dikaitkan dengan kondisi untuk tujuan tampilan.

Tanda Tangan:

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

SumberNilai

Menunjukkan sumber nilai.

  • "statis" menunjukkan bahwa nilai didefinisikan oleh konstanta statis.
  • "default" menunjukkan bahwa nilai yang ditetapkan oleh konfigurasi default.
  • "jarak jauh" menunjukkan nilai yang ditetapkan oleh konfigurasi yang dihasilkan dengan mengevaluasi template.

Tanda Tangan:

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

PercentConditionOperator

Menentukan operator yang didukung untuk kondisi persen.

Tanda Tangan:

export declare enum PercentConditionOperator 

Anggota Enumerasi

Anggota Nilai Deskripsi
ANTARA "BETWEEN" Persentil target dalam interval yang ditentukan oleh batas bawah dan batas atas. Batas bawah adalah batas eksklusif (terbuka) dan micro_percent_range_upper_bound adalah batas inklusif (tertutup). Kondisi yang menggunakan operator ini harus menentukan microPercentRange.
GREATER_THAN "GREATER_THAN" Persentil target lebih besar dari persen target. Kondisi yang menggunakan operator ini harus menentukan microPercent.
LEBIH SEDIKIT_ATAU_EQUAL "LESS_OR_EQUAL" Persentil target kurang dari atau sama dengan persen target. Kondisi yang menggunakan operator ini harus menentukan microPercent.
TIDAK DIKETAHUI "UNKNOWN" Kasus error umum.