RemoteConfig

RemoteConfig mewakili template Remote Config.

Template Remote Config suatu proyek dievaluasi selama pengambilan setiap instance aplikasi.

Nilai penyelesaian suatu parameter ditentukan sebagai berikut:

Mengingat conditional values yang mengacu pada conditions true untuk instance aplikasi, nilai penyelesaian parameter adalah nilai kondisional yang name paling awal dalam conditions list .

Selain itu, jika parameter memiliki default value , nilai yang diselesaikan akan diatur ke nilai default.

Jika tidak, parameter tersebut tidak memiliki nilai dan dihilangkan dari hasil yang diambil oleh instance aplikasi.

Misalnya, asumsikan kita memiliki kunci parameter fruit , dengan nilai default pear dan nilai kondisional submap {"is_ios": "apple", "is_in_20_percent": "banana"} dengan "is_ios" dan "is_20_percent" adalah nama kondisi yang diurutkan daftar kondisi. Nilai fruit akan bernilai apple jika is_ios benar. Sebaliknya, jika is_in_20_percent bernilai true , fruit akan bernilai banana , dan jika is_ios dan is_in_20_percent keduanya salah, fruit akan bernilai pear . Jika tidak ada nilai default yang ditentukan, dan is_ios serta is_in_20_percent keduanya salah, tidak ada nilai fruit yang akan dikembalikan dari server Remote Config ke klien.

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

Representasi JSON
{
  "conditions": [
    {
      object (RemoteConfigCondition)
    }
  ],
  "parameters": {
    string: {
      object (RemoteConfigParameter)
    },
    ...
  },
  "version": {
    object (Version)
  },
  "parameterGroups": {
    string: {
      object (RemoteConfigParameterGroup)
    },
    ...
  }
}
Bidang
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 ))

Peta kunci parameter ke nilai default opsional dan nilai kondisional opsionalnya.

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

version

object ( Version )

Hanya keluaran, kecuali description versi. Metadata terkait dengan versi templat tertentu. Bidang deskripsi versi dapat ditentukan dalam panggilan projects.updateRemoteConfig .

parameterGroups

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

Peta nama grup parameter hingga deskripsinya dan parameter yang dikelompokkan. Nama grup dapat diubah tetapi harus unik di antara grup-grup dalam konfigurasi. Nama dibatasi hingga 256 karakter dan dimaksudkan agar dapat dibaca manusia. Karakter Unicode apa pun diperbolehkan.

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 "Search V2" mungkin memiliki description "Tampilan penelusuran seluler baru" dan berisi parameter untuk tata letak dan font penelusuran baru.

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

Kondisi Konfigurasi Jarak Jauh

Suatu kondisi yang menargetkan sekelompok pengguna tertentu. Daftar kondisi ini merupakan bagian dari objek RemoteConfig.

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

string

Diperlukan. Nama yang tidak kosong dan unik untuk kondisi ini.

expression

string

Diperlukan. Logika dari kondisi ini.

Lihat dokumentasi mengenai Ekspresi Kondisi untuk sintaks yang diharapkan dari bidang ini.

tagColor

enum ( ConditionDisplayColor )

Opsional. Warna yang terkait dengan kondisi ini untuk tujuan tampilan di Firebase Console. Tidak menentukan nilai ini atau memiliki "CONDITION_DISPLAY_COLOR_UNSPECIFIED" mengakibatkan Konsol memilih warna sewenang-wenang untuk dikaitkan dengan kondisi.

KondisiTampilanWarna

Daftar warna yang terkait dengan Ketentuan untuk tujuan tampilan.

Enum
CONDITION_DISPLAY_COLOR_UNSPECIFIED
BLUE Biru
BROWN Cokelat
CYAN Sian
DEEP_ORANGE alias "Merah Oranye"
GREEN Hijau
INDIGO Nila
LIME jeruk nipis
ORANGE Oranye
PINK Merah Jambu
PURPLE Ungu
TEAL teal

Parameter Konfigurasi Jarak Jauh

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

Minimal, entri defaultValue atau conditionalValues ​​harus ada agar parameter memiliki efek apa pun.

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

object ( RemoteConfigParameterValue )

Opsional - nilai untuk menyetel parameter, ketika tidak ada kondisi bernama yang bernilai true .

conditionalValues

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

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

Sebuah objek yang berisi daftar "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 )

Tipe data untuk semua nilai parameter ini dalam versi templat saat ini. Defaultnya adalah ParameterValueType.STRING jika tidak ditentukan.

NilaiParameterConfig Jarak Jauh

Sumber daya RemoteConfigParameterValue berisi nilai yang mungkin dimiliki suatu parameter.

Representasi JSON
{

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

string

Nilai string yang parameternya disetel.

useInAppDefault

boolean

Jika benar, parameter tersebut dihilangkan dari nilai parameter yang dikembalikan ke klien.

personalizationValue

object ( PersonalizationValue )

Nilai dinamis khusus pengguna yang dihitung saat konfigurasi diambil.

Nilai Personalisasi

Berisi informasi yang diperlukan untuk mengambil nilai yang dipersonalisasi.

Representasi JSON
{
  "personalizationId": string
}
Bidang
personalizationId

string

Pengidentifikasi yang mewakili definisi personalisasi. Definisi ini digunakan untuk menyelesaikan nilai pada waktu pengambilan konfigurasi. Nilai yang dihasilkan sistem ini tidak boleh diubah.

ParameterValueType

Tipe data yang diterima untuk nilai parameter.

Enum
PARAMETER_VALUE_TYPE_UNSPECIFIED Catch-all untuk nilai enum yang tidak dikenal.
STRING Mewakili nilai String.
BOOLEAN Mewakili nilai Boolean ("benar" atau "salah").
NUMBER Mewakili nilai integer dan float positif dan negatif.
JSON Mewakili nilai JSON.

Grup RemoteConfigParameter

Sekelompok parameter bernama. Pengelompokan parameter hanya untuk tujuan manajemen dan tidak memengaruhi pengambilan nilai parameter di sisi klien.

Representasi JSON
{
  "description": string,
  "parameters": {
    string: {
      object (RemoteConfigParameter)
    },
    ...
  }
}
Bidang
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 ))

Peta kunci parameter ke nilai default opsionalnya dan nilai kondisional opsional untuk parameter yang termasuk dalam grup ini. Parameter hanya muncul sekali per RemoteConfig: parameter yang tidak dikelompokkan muncul di tingkat atas; parameter yang diorganisir dalam suatu grup muncul dalam peta parameter grupnya.

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