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 nilainya di cloud, yang memungkinkan Anda untuk memodifikasi tampilan dan perilaku aplikasi tanpa mendistribusikan update aplikasi. Panduan ini akan menuntun Anda menjalankan langkah-langkah untuk memulai, serta menyediakan kode contoh yang semuanya dapat di-clone atau didownload dari repositori GitHub firebase/quickstart-ios.

Langkah 1: Menambahkan Remote Config ke aplikasi

1. Jika belum, tambahkan Firebase ke project Apple Anda.

2. Untuk Remote Config, Google Analytics diperlukan untuk penargetan kondisional instance aplikasi ke properti pengguna dan audience. Pastikan Anda mengaktifkan Google Analytics di project Anda.

3. Buat objek Remote Config singleton, seperti yang ditunjukkan pada contoh berikut:

   Swift

   remoteConfig = RemoteConfig.remoteConfig()
   let settings = RemoteConfigSettings()
   settings.minimumFetchInterval = 0
   remoteConfig.configSettings = settings
   ViewController.swift

   Objective-C

   self.remoteConfig = [FIRRemoteConfig remoteConfig];
   FIRRemoteConfigSettings *remoteConfigSettings = [[FIRRemoteConfigSettings alloc] init];
   remoteConfigSettings.minimumFetchInterval = 0;
   self.remoteConfig.configSettings = remoteConfigSettings;
   ViewController.m

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

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

Langkah 2: 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 simpan 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.

1. Tentukan sekumpulan nama parameter dan parameter value default menggunakan objek NSDictionary atau file plist.

   Jika sudah mengonfigurasi parameter value backend Remote Config, Anda dapat mendownload file plist yang dihasilkan yang berisi semua nilai default dan menyimpannya ke project Xcode.

   REST

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

   Firebase console

   1. Di tab Parameters, buka Menu, lalu pilih Download default values.

   2. Jika diminta, aktifkan .plist for iOS, lalu klik Download file.

2. Tambahkan nilai ini ke objek Remote Config menggunakan setDefaults:. Contoh berikut menetapkan nilai default dalam aplikasi dari file plist:

   Swift

   remoteConfig.setDefaults(fromPlist: "RemoteConfigDefaults")
   ViewController.swift

   Objective-C

   [self.remoteConfig setDefaultsFromPlistFileName:@"RemoteConfigDefaults"];
   ViewController.m

Catatan: Cuplikan kode ini merujuk pada file RemoteConfigDefaults.plist dari contoh project quickstart-ios. Jika Anda menggunakan file default yang didownload, gunakan remote_config_defaults.

Langkah 3: Mendapatkan parameter value yang akan digunakan dalam aplikasi

Sekarang Anda bisa mendapatkan parameter value dari objek Remote Config. Jika Anda kemudian menetapkan nilai pada backend Remote Config, mengambilnya, lalu mengaktifkannya, nilai tersebut akan tersedia untuk aplikasi Anda. Jika tidak, Anda akan mendapatkan parameter value dalam aplikasi yang dikonfigurasi menggunakan setDefaults:. Untuk mendapatkan nilai ini, panggil metode configValueForKey: dan sediakan kunci parameter sebagai argumen.

Langkah 4: Menetapkan parameter value

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

1. Buka project Anda di Firebase console.
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 nilai default (yang akan menggantikan nilai default dalam aplikasi) dan menetapkan nilai kondisional. Untuk mempelajari lebih lanjut, baca artikel Parameter dan Kondisi Remote Config.

Langkah 5: Mengambil dan mengaktifkan nilai

Untuk mengambil parameter value dari Remote Config, panggil metode fetchWithCompletionHandler: atau fetchWithExpirationDuration:completionHandler:. Setiap nilai yang Anda tetapkan pada backend akan diambil dan disimpan dalam cache di objek Remote Config.

Jika Anda ingin mengambil dan mengaktifkan nilai dalam satu panggilan, gunakan fetchAndActivateWithCompletionHandler:.

Contoh ini mengambil nilai dari backend Remote Config (bukan nilai yang disimpan dalam cache) dan memanggil activateWithCompletionHandler: agar tersedia di aplikasi:

Swift

remoteConfig.fetch { (status, error) -> Void in
  if status == .success {
    print("Config fetched!")
    self.remoteConfig.activate { changed, error in
      // ...
    }
  } else {
    print("Config not fetched")
    print("Error: \(error?.localizedDescription ?? "No error available.")")
  }
  self.displayWelcome()
}
ViewController.swift

Objective-C

[self.remoteConfig fetchWithCompletionHandler:^(FIRRemoteConfigFetchStatus status, NSError *error) {
    if (status == FIRRemoteConfigFetchStatusSuccess) {
        NSLog(@"Config fetched!");
      [self.remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
        if (error != nil) {
          NSLog(@"Activate error: %@", error.localizedDescription);
        } else {
          dispatch_async(dispatch_get_main_queue(), ^{
            [self displayWelcome];
          });
        }
      }];
    } else {
        NSLog(@"Config not fetched");
        NSLog(@"Error %@", error.localizedDescription);
    }
}];
ViewController.m

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.

Langkah 6: Memproses update secara real time

Setelah mengambil parameter value, Anda dapat menggunakan Remote Config real-time untuk memproses update dari backend Remote Config. Sinyal Remote Config real-time ke perangkat yang terhubung saat update tersedia dan secara otomatis mengambil perubahan setelah Anda memublikasikan versi Remote Config baru.

Update real-time didukung oleh Firebase SDK untuk platform Apple v10.7.0+ dan versi yang lebih baru.

Penting: Remote Config real-time juga memerlukan Firebase Remote Config Realtime API, yang seharusnya sudah diaktifkan untuk Anda. Untuk memverifikasi, buka Google Cloud console, pilih project Anda, lalu buka halaman APIs and Services. API seharusnya muncul sebagai diaktifkan. Jika tidak ada, atau tidak diaktifkan, klik Enable APIs & Services, telusuri Firebase Remote Config Realtime API, lalu aktifkan.

1. Di aplikasi Anda, panggil addOnConfigUpdateListener untuk mulai memproses update dan otomatis mengambil parameter value baru atau yang diperbarui. Contoh berikut memproses update dan saat activateWithCompletionHandler dipanggil, menggunakan nilai yang baru diambil untuk menampilkan pesan selamat datang yang diperbarui.

   Swift

   remoteConfig.addOnConfigUpdateListener { configUpdate, error in
     guard let configUpdate, error == nil else {
       print("Error listening for config updates: \(error)")
     }
   
     print("Updated keys: \(configUpdate.updatedKeys)")
   
     self.remoteConfig.activate { changed, error in
       guard error == nil else { return self.displayError(error) }
       DispatchQueue.main.async {
         self.displayWelcome()
       }
     }
   }
   

   Objective-C

   __weak __typeof__(self) weakSelf = self;
   [self.remoteConfig addOnConfigUpdateListener:^(FIRRemoteConfigUpdate * _Nonnull configUpdate, NSError * _Nullable error) {
     if (error != nil) {
       NSLog(@"Error listening for config updates %@", error.localizedDescription);
     } else {
       NSLog(@"Updated keys: %@", configUpdate.updatedKeys);
   
       __typeof__(self) strongSelf = weakSelf;
       [strongSelf.remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
         if (error != nil) {
           NSLog(@"Activate error %@", error.localizedDescription);
         }
   
         dispatch_async(dispatch_get_main_queue(), ^{
           [strongSelf displayWelcome];
         });
       }];
     }
   }];
   

2. Jika kemudian Anda memublikasikan versi baru Remote Config, perangkat yang menjalankan aplikasi dan memproses perubahan akan memanggil pengendali penyelesaian.

Throttling

Jika aplikasi terlalu sering melakukan pengambilan dalam jangka waktu yang singkat, panggilan pengambilan akan dibatasi dan SDK akan menampilkan FIRRemoteConfigFetchStatusThrottled. Sebelum SDK versi 6.3.0, batasnya adalah 5 permintaan pengambilan dalam jangka waktu 60 menit (versi yang lebih baru memiliki batas yang lebih fleksibel).

Tips: Mulai dari SDK platform Apple v10.7.0+, Anda dapat menggunakan Remote Config real-time untuk mengambil parameter value yang telah diperbarui secara otomatis dari Backend Remote Config segera setelah dipublikasikan, mengabaikan setelan interval pengambilan minimum. Anda dapat menggunakan update real-time daripada mengambil data secara rutin untuk merefresh cache. Untuk informasi selengkapnya, lihat Memproses update secara real time.

Selama pengembangan aplikasi, sebaiknya lebih sering melakukan pengambilan untuk refresh cache sesering mungkin (berkali-kali per jam) agar Anda dapat melakukan iterasi dengan cepat ketika mengembangkan dan menguji aplikasi. Update Remote Config real-time secara otomatis mengabaikan cache ketika konfigurasi diperbarui di server. Untuk mengakomodasi iterasi yang cepat pada project yang beranggotakan banyak developer, Anda dapat menambahkan properti FIRRemoteConfigSettings dengan interval pengambilan minimum yang rendah (MinimumFetchInterval) 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 sebagai berikut:

1. Parameter di fetch(long)
2. Parameter di FIRRemoteConfigSettings.MinimumFetchInterval
3. 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 sangat 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