Mulai Menggunakan Firebase Remote Config

iOS+ Android Web Flutter Unity C++

Penting: Bagian ini menjelaskan langkah-langkah untuk mengonfigurasi Remote Config dengan klien seluler dan web. Untuk lingkungan server, lihat Menggunakan Remote Config di lingkungan server.

Anda dapat menggunakan Firebase Remote Config untuk menetapkan parameter dalam aplikasi dan memperbarui value-nya di cloud, sehingga Anda dapat memodifikasi tampilan dan perilaku aplikasi tanpa mendistribusikan update aplikasi. Panduan ini akan menuntun Anda menjalankan langkah-langkah untuk memulai, serta menyediakan beberapa kode contoh, yang semuanya dapat di-clone atau didownload dari repositori GitHub firebase/quickstart-js.

Langkah 1: Menambahkan dan melakukan inisialisasi Remote Config SDK

Catatan: Saat menginstal SDK, Anda memiliki opsi menambahkan dependensi untuk Analytics. Analytics diperlukan untuk penargetan kondisional instance aplikasi Remote Config ke properti pengguna dan audience.

1. Jika Anda belum melakukannya, instal Firebase JS SDK dan inisialisasi Firebase.

2. Tambahkan Remote Config JS SDK dan lakukan inisialisasi Remote Config:

Web

Pelajari lebih lanjut Web API modular yang dapat di-tree shaking dan upgrade dari API namespaced.

import { initializeApp } from "firebase/app";
import { getRemoteConfig } from "firebase/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = getRemoteConfig(app);

Web

Pelajari lebih lanjut Web API modular yang dapat di-tree shaking dan upgrade dari API dengan namespace.

import firebase from "firebase/compat/app";
import "firebase/compat/remote-config";

// TODO: Replace the following with your app's Firebase project configuration
// See: https://firebase.google.com/docs/web/learn-more#config-object
const firebaseConfig = {
  // ...
};

// Initialize Firebase
firebase.initializeApp(firebaseConfig);


// Initialize Remote Config and get a reference to the service
const remoteConfig = firebase.remoteConfig();

Objek ini digunakan untuk menyimpan parameter value default dalam aplikasi, mengambil parameter value terbaru dari backend Remote Config, dan mengontrol kapan value yang diambil akan tersedia untuk aplikasi Anda.

Langkah 2: Menetapkan interval pengambilan minimum

Selama pengembangan, sebaiknya tetapkan interval pengambilan minimum yang relatif rendah. Baca Throttling untuk mengetahui informasi selengkapnya.

Web

Pelajari lebih lanjut Web API modular yang dapat di-tree shaking dan upgrade dari API namespaced.

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
rc_set_minimum_fetch_time.js

Web

remoteConfig.settings.minimumFetchIntervalMillis = 3600000;
index.js

Langkah 3: Menetapkan parameter value default dalam aplikasi

Anda bisa menetapkan parameter value default dalam aplikasi di objek Remote Config agar aplikasi Anda berperilaku seperti yang diharapkan sebelum terhubung ke backend Remote Config, dan agar ada value default yang tersedia jika tidak ada value yang ditetapkan pada backend.

Penting: Jangan menyimpan data rahasia di kunci parameter atau parameter value Remote Config. Data Remote Config dienkripsi saat dalam pengiriman, tetapi pengguna akhir dapat mengakses parameter Remote Config default atau yang diambil dan tersedia untuk instance aplikasi klien mereka.

Web

Pelajari lebih lanjut Web API modular yang dapat di-tree-shaking dan upgrade dari API dengan namespace.

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};
rc_set_default_values.js

Web

remoteConfig.defaultConfig = {
  "welcome_message": "Welcome"
};
index.js

Jika sudah mengonfigurasi parameter value backend Remote Config, Anda dapat mendownload file JSON yang dihasilkan yang mencakup semua value default dan menyertakannya dalam app bundle:

REST

curl --compressed -D headers -H "Authorization: Bearer token" -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=JSON -o remote_config_defaults.json

Firebase console

1. Di tab Parameters, buka Menu, lalu pilih Download default values.
2. Jika diminta, aktifkan .json for web, lalu klik Download file.

Contoh berikut menunjukkan dua cara berbeda untuk mengimpor dan menetapkan nilai default di aplikasi Anda. Contoh pertama menggunakan fetch, yang akan membuat permintaan HTTP ke file default yang disertakan dalam app bundle Anda:

  const rcDefaultsFile = await fetch('remote_config_defaults.json');
  const rcDefaultsJson = await rcDefaultsFile.json();
  remoteConfig.defaultConfig = rcDefaultsJson;
  

Contoh berikutnya menggunakan require, yang mengompilasi nilai ke dalam aplikasi Anda pada waktu build:

  let rcDefaults = require('./remote_config_defaults.json');
  remoteConfig.defaultConfig = rcDefaults;

Langkah 4: Mendapatkan parameter value yang akan digunakan dalam aplikasi

Sekarang Anda bisa mendapatkan parameter value dari objek Remote Config. Jika nantinya Anda menetapkan value di backend, mengambilnya, lalu mengaktifkannya, value tersebut akan tersedia untuk aplikasi Anda. Untuk mendapatkan value ini, panggil metode getValue(), dengan kunci parameter sebagai argumen.

Web

Pelajari lebih lanjut Web API modular yang dapat di-tree shaking dan upgrade dari API namespaced.

import { getValue } from "firebase/remote-config";

const val = getValue(remoteConfig, "welcome_messsage");
rc_get_values.js

Web

const val = remoteConfig.getValue("welcome_messsage");
index.js

Langkah 5: Menetapkan parameter value

Dengan menggunakan konsol Firebase atau API backend Remote Config, Anda dapat membuat value default sisi server baru yang menggantikan value dalam aplikasi sesuai dengan penargetan pengguna atau logika kondisional yang diinginkan. Bagian ini akan menuntun Anda menjalankan langkah-langkah di Firebase console untuk membuat value tersebut.

1. Di Firebase console, buka project Anda.
2. Pilih Remote Config dari menu untuk melihat dasbor Remote Config.
3. Tetapkan parameter dengan nama yang sama dengan parameter yang Anda tetapkan dalam aplikasi. Untuk setiap parameter, Anda dapat menetapkan value default (yang akan menggantikan value default dalam aplikasi) dan menetapkan value kondisional. Untuk mempelajari lebih lanjut, lihat Parameter dan Kondisi Remote Config.

Langkah 6: Mengambil dan mengaktifkan value

1. Untuk mengambil parameter value dari backend Remote Config, panggil metode fetchConfig(). Setiap value yang Anda tetapkan pada backend akan diambil dan di-cache di objek Remote Config.
2. Agar parameter value yang diambil tersedia untuk aplikasi Anda, panggil metode activate().

Jika ingin mengambil dan mengaktifkan nilai dalam satu panggilan, gunakan fetchAndActivate() seperti yang ditunjukkan dalam contoh ini:

Web

Pelajari lebih lanjut Web API modular yang dapat di-tree shaking dan upgrade dari API namespaced.

import { fetchAndActivate } from "firebase/remote-config";

fetchAndActivate(remoteConfig)
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });
rc_fetch_config_callback.js

Web

remoteConfig.fetchAndActivate()
  .then(() => {
    // ...
  })
  .catch((err) => {
    // ...
  });
index.js

Karena parameter value terbaru ini memengaruhi perilaku dan tampilan aplikasi, Anda harus mengaktifkan nilai yang diambil pada saat yang tepat untuk memastikan pengalaman yang lancar bagi pengguna, misalnya saat pengguna membuka aplikasi di waktu berikutnya. Lihat Strategi pemuatan Remote Config untuk mengetahui informasi dan contoh selengkapnya.

Throttling

Jika aplikasi terlalu sering melakukan pengambilan dalam jangka waktu yang singkat, panggilan pengambilan dapat di-throttle. Dalam kasus seperti itu, SDK akan menampilkan error FETCH_THROTTLE. Sebaiknya tangkap error ini dan coba lagi dalam mode backoff eksponensial, yakni dengan menunggu dalam interval yang lebih lama antarpermintaan pengambilan.

Selama pengembangan aplikasi, sebaiknya refresh cache sesering mungkin (berkali-kali per jam) agar Anda dapat melakukan iterasi dengan cepat ketika mengembangkan dan menguji aplikasi. Untuk mengakomodasi iterasi yang cepat pada project yang beranggotakan banyak developer, Anda dapat menambahkan properti dengan interval pengambilan minimum yang rendah (Settings.minimumFetchIntervalMillis) ke dalam aplikasi Anda untuk sementara.

Interval pengambilan produksi default dan yang disarankan untuk Remote Config adalah 12 jam. Artinya, konfigurasi tidak akan diambil dari backend lebih dari sekali dalam jangka waktu 12 jam, terlepas dari berapa banyak panggilan pengambilan yang sebenarnya dilakukan. Secara khusus, interval pengambilan minimum ditentukan dengan urutan berikut:

1. Parameter di Settings.minimumFetchIntervalMillis
2. Nilai default 12 jam.

Perlu diingat bahwa setelan ini sebaiknya digunakan hanya untuk pengembangan, bukan untuk aplikasi yang berjalan di produksi. Jika hanya ingin menguji aplikasi dengan tim pengembangan yang terdiri dari 10 orang, kecil kemungkinan Anda mencapai batas kuota sisi layanan per jam. Namun, jika Anda mendistribusikan aplikasi ke ribuan pengguna uji coba dengan interval pengambilan minimum yang rendah, aplikasi mungkin akan mencapai kuota ini.

Langkah berikutnya

Pelajari kasus penggunaan Remote Config jika Anda belum melakukannya, dan lihat beberapa dokumentasi strategi lanjutan dan konsep utama, termasuk:

• Mengelola versi template Remote Config
• Strategi pemuatan Config