RemoteConfig

RemoteConfig mewakili template Remote Config.

Template Remote Config project dievaluasi selama pengambilan setiap instance aplikasi.

Catatan: Template server saat ini mendukung kondisi persentase. Memublikasikan template server dengan nilai kondisional yang tidak didukung akan menampilkan error validasi. Lihat Remote Config di Lingkungan Server untuk mengetahui informasi selengkapnya.

Nilai parameter yang di-resolve ditentukan sebagai berikut:

Dengan mempertimbangkan conditional values yang merujuk ke true conditions untuk instance aplikasi, nilai parameter yang di-resolve adalah nilai kondisional yang name-nya paling awal dalam conditions list.

Selain itu, jika parameter memiliki default value, nilai yang di-resolve ditetapkan ke nilai default.

Selain itu, parameter tidak memiliki nilai dan dihilangkan dari hasil yang diambil instance aplikasi.

Misalnya, anggaplah kita memiliki kunci parameter fruit, dengan nilai default pear dan subpeta nilai bersyarat {"is_ios": "apple", "is_in_20_percent": "banana"} dengan "is_ios" dan "is_20_percent" adalah nama kondisi dalam daftar kondisi yang diurutkan. Nilai fruit akan dievaluasi menjadi apple jika is_ios benar. Sebaliknya, jika is_in_20_percent adalah true, fruit akan bernilai banana, dan jika is_ios dan is_in_20_percent bernilai salah, fruit akan bernilai pear. Jika tidak ada nilai default yang ditentukan, dan is_ios serta is_in_20_percent bernilai salah, tidak ada nilai untuk fruit yang akan ditampilkan dari server Remote Config ke klien.

Setelah template Remote Config project dipublikasikan melalui panggilan projects.updateRemoteConfig yang berhasil, klien dapat mengambil parameter value ini dan menampilkannya kepada pengguna.

Representasi JSON
{
  "conditions": [
    {
      object (RemoteConfigCondition)
    }
  ],
  "parameters": {
    string: {
      object (RemoteConfigParameter)
    },
    ...
  },
  "version": {
    object (Version)
  },
  "parameterGroups": {
    string: {
      object (RemoteConfigParameterGroup)
    },
    ...
  }
}
Kolom
conditions[]

object (RemoteConfigCondition)

Daftar kondisi dalam urutan menurun berdasarkan prioritas.

Nilai entri google.firebase.remoteconfig.v1.RemoteConfigCondition.name harus unik.

parameters

map (key: string, value: object (RemoteConfigParameter))

Petakan kunci parameter ke nilai default opsional dan nilai kondisional opsional.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

version

object (Version)

Hanya output, kecuali untuk versi description. Metadata yang terkait dengan versi template tertentu. Kolom deskripsi versi dapat ditentukan dalam panggilan projects.updateRemoteConfig.

parameterGroups

map (key: string, value: object (RemoteConfigParameterGroup))

Petakan nama grup parameter ke deskripsi dan parameter yang dikelompokkan. Nama grup dapat diubah, tetapi harus unik di antara grup dalam konfigurasi. Nama dibatasi hingga 256 karakter dan dimaksudkan agar dapat dibaca manusia. Karakter Unicode apa pun diizinkan.

Grup memiliki daftar parameter yang memungkinkan pengguna API mengelompokkan parameter yang terkait dengan fitur atau tema yang sama untuk memudahkan akses organisasi.

Misalnya, grup parameter dengan nama "Penelusuran V2" dapat memiliki description "Tampilan penelusuran seluler baru" serta berisi parameter untuk tata letak dan font penelusuran baru.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

RemoteConfigCondition

Kondisi yang menargetkan grup pengguna tertentu. Daftar kondisi ini merupakan bagian dari objek RemoteConfig.

Representasi JSON
{
  "name": string,
  "expression": string,
  "tagColor": enum (ConditionDisplayColor)
}
Kolom
name

string

Wajib diisi. Nama unik dan tidak kosong dari kondisi ini.

expression

string

Wajib diisi. Logika kondisi ini.

Lihat dokumentasi terkait Ekspresi Kondisi untuk sintaksis yang diharapkan untuk kolom ini.

tagColor

enum (ConditionDisplayColor)

Opsional. Warna yang terkait dengan kondisi ini untuk tujuan tampilan di Firebase Console. Jika nilai ini tidak ditentukan atau "Condition_DISPLAY_COLOR_UNSPECIFIED" tidak ditentukan, maka Console akan memilih warna arbitrer untuk dikaitkan dengan kondisi.

WarnaTampilanKondisi

Daftar warna yang dikaitkan dengan Kondisi untuk tujuan tampilan.

Enum
CONDITION_DISPLAY_COLOR_UNSPECIFIED
BLUE Biru
BROWN Cokelat
CYAN Sian
DEEP_ORANGE Disebut juga "Oranye Merah"
GREEN Hijau
INDIGO Nila
LIME Kapur
ORANGE Jeruk
PINK Merah Muda
PURPLE Ungu
TEAL Hijau laut

RemoteConfigParameter

Nilai parameter yang terkait dengan kunci parameter di google.firebase.remoteconfig.v1.RemoteConfig.parameters.

Setidaknya, entri defaultValue atau conditionalValues harus ada agar parameter dapat memberikan pengaruh.

Representasi JSON
{
  "defaultValue": {
    object (RemoteConfigParameterValue)
  },
  "conditionalValues": {
    string: {
      object (RemoteConfigParameterValue)
    },
    ...
  },
  "description": string,
  "valueType": enum (ParameterValueType)
}
Kolom
defaultValue

object (RemoteConfigParameterValue)

Opsional - nilai untuk menetapkan parameter, saat tidak ada kondisi yang dinamai yang bernilai true.

conditionalValues

map (key: string, value: object (RemoteConfigParameterValue))

Opsional - peta (condition name, nilai). condition_name dari prioritas tertinggi (yang tercantum pertama dalam daftar kondisi RemoteConfig) menentukan nilai parameter ini.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

description

string

Opsional. Deskripsi untuk Parameter ini. Panjangnya harus kurang dari atau sama dengan 256 karakter . Deskripsi dapat berisi karakter Unicode apa pun.

valueType

enum (ParameterValueType)

Jenis data untuk semua nilai parameter ini dalam versi template saat ini. Jika tidak ditentukan, setelan defaultnya adalah ParameterValueType.STRING.

RemoteConfigParameterValue

Resource RemoteConfigParameterValue berisi nilai yang mungkin dimiliki parameter.

Representasi JSON
{

  // Union field value_option can be only one of the following:
  "value": string,
  "useInAppDefault": boolean,
  "personalizationValue": {
    object (PersonalizationValue)
  },
  "rolloutValue": {
    object (RolloutValue)
  }
  // End of list of possible types for union field value_option.
}
Kolom
Kolom union value_option. RemoteConfigParameterValue terdiri dari string (nilai) atau boolean (use_in_app_default, ditetapkan ke true jika berlaku). value_option hanya ada berupa salah satu diantara berikut:
value

string

Nilai string tempat parameter ditetapkan.

useInAppDefault

boolean

Jika true (benar), parameter akan dihilangkan dari nilai parameter yang ditampilkan ke klien.

personalizationValue

object (PersonalizationValue)

Nilai dinamis khusus pengguna yang dihitung saat konfigurasi diambil.

rolloutValue

object (RolloutValue)

Nilai Peluncuran dinamis yang dikelola oleh layanan Eksperimen ABT Firebase.

Nilai Personalisasi

Berisi informasi yang diperlukan untuk mengambil nilai yang dipersonalisasi.

Representasi JSON
{
  "personalizationId": string
}
Kolom
personalizationId

string

ID yang merepresentasikan definisi personalisasi. Definisi ini digunakan untuk me-resolve nilai pada waktu pengambilan konfigurasi. Nilai yang dihasilkan sistem ini tidak boleh diubah.

launchValue

Informasi yang terkait dengan Peluncuran.

Representasi JSON
{
  "rolloutId": string,
  "value": string,
  "percent": number
}
Kolom
rolloutId

string

ID yang mengaitkan nilai parameter ke eksperimen Peluncuran.

value

string

Nilai yang ditentukan pengguna yang akan diluncurkan.

percent

number

Persentase pengguna yang akan menerima nilai peluncuran.

JenisParameterValue

Jenis data yang diterima untuk parameter value.

Enum
PARAMETER_VALUE_TYPE_UNSPECIFIED Tangkap semua untuk nilai enum yang tidak dikenal.
STRING Mewakili nilai-nilai String.
BOOLEAN Merepresentasikan nilai Boolean ("true" atau "false").
NUMBER Mewakili nilai bilangan bulat dan nilai float positif dan negatif.
JSON Mewakili nilai JSON.

RemoteConfigParameterGroup

Grup parameter bernama. Pengelompokan parameter hanya untuk tujuan pengelolaan dan tidak memengaruhi pengambilan parameter value sisi klien.

Representasi JSON
{
  "description": string,
  "parameters": {
    string: {
      object (RemoteConfigParameter)
    },
    ...
  }
}
Kolom
description

string

Opsional. Deskripsi untuk grup. Panjangnya harus kurang dari atau sama dengan 256 karakter. Deskripsi dapat berisi karakter Unicode apa pun.

parameters

map (key: string, value: object (RemoteConfigParameter))

Petakan kunci parameter ke nilai default opsional dan nilai kondisional opsional untuk parameter yang termasuk dalam grup ini. Parameter hanya muncul sekali per RemoteConfig: parameter yang tidak dikelompokkan muncul di tingkat teratas; parameter yang diatur dalam grup muncul dalam peta parameter grupnya.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.