firebase-admin.remote-config package

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
Kondisi Mewakili kumpulan kondisi yang bernilai benar jika semuanya 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 merepresentasikan opsi untuk operasi versi daftar Remote Config.
ListVersionsResult Antarmuka yang mewakili daftar versi template Remote Config.
MicroPercentRange Mewakili batas persentil untuk ditargetkan dalam persentase mikro. Nilai harus dalam rentang [0 dan 100000000]
NamedCondition Mewakili kondisi Remote Config dalam dataplane. Kondisi menargetkan grup pengguna tertentu. Daftar kondisi ini merupakan bagian dari template Remote Config.
OneOfCondition Mewakili kondisi yang mungkin merupakan salah satu dari beberapa jenis. Hanya kolom yang pertama ditentukan yang akan diproses.
OrCondition Mewakili kumpulan kondisi yang bernilai benar jika ada yang benar.
PercentCondition Mewakili kondisi yang membandingkan persentil pseudo-random instance dengan batas tertentu.
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 berpengaruh.
RemoteConfigParameterGroup Antarmuka yang mewakili grup parameter Remote Config. Pengelompokan parameter hanya untuk tujuan pengelolaan dan tidak memengaruhi pengambilan parameter value sisi klien.
RemoteConfigTemplate Merepresentasikan template klien Remote Config.
RemoteConfigUser Antarmuka yang mewakili pengguna Remote Config.
ServerConfig Menampilkan konfigurasi yang dihasilkan dengan mengevaluasi template server.
ServerTemplate Merepresentasikan abstraksi stateful untuk template server Remote Config.
ServerTemplateData Mewakili data dalam template server Remote Config.
Nilai Menggabungkan nilai parameter dengan metadata dan pengambil jenis yang aman.Pengambil dengan jenis yang aman mengisolasi logika aplikasi dari perubahan jarak jauh terhadap 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.

Jenis Alias

Jenis Alias Deskripsi
DefaultConfig Menentukan format untuk parameter value default dalam aplikasi.
EvaluasiContext Mewakili sinyal input evaluasi template.
ParameterValueType Jenis yang mewakili jenis data nilai parameter Remote Config. Jika tidak ditentukan, setelan defaultnya adalah STRING.
RemoteConfigParameterValue Jenis yang mewakili nilai parameter Remote Config. RemoteConfigParameterValue dapat berupa ExplicitParameterValue atau InAppDefaultValue.
ServerTemplateDataType Mewakili jenis template server Remote Config yang dapat ditetapkan pada ServerTemplate. String ini dapat berupa objek ServerTemplateData atau string JSON template.
WarnaTag Warna yang dikaitkan dengan kondisi untuk tujuan tampilan.
Sumber Nilai Menunjukkan sumber nilai.
  • "statis" menunjukkan nilai didefinisikan oleh konstanta statis.
  • "default" menunjukkan nilai yang ditentukan oleh konfigurasi default.
  • "remote" menunjukkan nilai yang didefinisikan 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

Mewakili sinyal input evaluasi template.

Tanda Tangan:

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

JenisParameterValue

Jenis yang mewakili jenis data nilai parameter Remote Config. Jika tidak ditentukan, setelan defaultnya adalah STRING.

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

Mewakili jenis template server Remote Config yang dapat ditetapkan pada ServerTemplate. String 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 nilai didefinisikan oleh konstanta statis.
  • "default" menunjukkan nilai yang ditentukan oleh konfigurasi default.
  • "remote" menunjukkan nilai yang didefinisikan 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" Target persentil dalam interval yang ditentukan oleh batas bawah dan batas atas. Batas bawah adalah batas eksklusif (terbuka) dan rentang_rentang_mikro_batas_atas adalah batas inklusif (tertutup). Ketentuan yang menggunakan operator ini harus menetapkan microPercentRange.
GREATER_THAN "GREATER_THAN" Target persentil yang lebih besar dari persentase target. Kondisi yang menggunakan operator ini harus menentukan microPercent.
LESS_OR_EQUAL "LESS_OR_EQUAL" Target persentil kurang dari atau sama dengan persentase target. Kondisi yang menggunakan operator ini harus menentukan microPercent.
TIDAK DIKETAHUI "UNKNOWN" Kasus error umum.