Anda dapat menginstal (dan mengelola) ekstensi Firebase resmi menggunakan Firebase console, Firebase CLI (antarmuka command line), atau menggunakan SDK yang dibuat secara otomatis.
Pastikan untuk meninjau perbedaan tindakan yang didukung untuk setiap metode penginstalan.
Untuk menginstal atau mengelola ekstensi, salah satu peran berikut harus ditetapkan untuk Anda: Pemilik atau Editor atau Firebase Admin.
Untuk menginstal ekstensi, project Anda harus menggunakan paket Blaze (bayar sesuai penggunaan). Meskipun penginstalan ekstensi dapat dilakukan secara gratis, Anda mungkin akan dikenai biaya atas penggunaan layanan Firebase atau layanan Cloud seperti Cloud Secret Manager, jika penggunaan Anda melebihi paket gratis layanan tersebut.
Sebelum memulai
Tambahkan Firebase ke project Anda dan upgrade project Firebase ke paket Blaze (bayar sesuai penggunaan), jika belum melakukannya.
Langkah 1: Lihat informasi mendetail tentang ekstensi
Langkah ini bersifat opsional, tetapi sangat direkomendasikan.
Sebelum menginstal Firebase Extension, sebaiknya Anda meninjau informasi mendetail tentang ekstensi tersebut, termasuk:
- Cara kerja ekstensi, tugas pra-penginstalan, dan detail tentang ekstensi
- Informasi dan deskripsi identitas umum
- Apakah tugas ekstensi memerlukan akun penagihan atau tidak
- Layanan Google (API) dan peran akses yang diperlukan untuk operasi
- Resource yang dibuat untuk ekstensi (seperti fungsi)
- Deskripsi parameter yang dapat dikonfigurasi oleh pengguna
Untuk melihat informasi mendetail tentang ekstensi:
Jelajahi ekstensi Firebase resmi di Extensions Hub.
Klik kartu ekstensi untuk:
Menampilkan informasi selengkapnya tentang ekstensi tersebut.
Menemukan link ke kode sumber ekstensi di repositori sumber Firebase Extensions.
Dalam direktori ekstensi untuk ekstensi tersebut, Anda dapat melihat informasi mendetail ini di
README.
Langkah 2: Instal ekstensi
Selama proses penginstalan, Anda akan diminta untuk meninjau spesifikasi dasar ekstensi (seperti API yang diaktifkan, resource yang dibuat, akses yang diberikan, dll.). Anda akan diberi tahu tentang persyaratan penagihan, dan juga akan diminta menentukan nilai parameter yang dapat dikonfigurasi untuk ekstensi tersebut.
Jelajahi ekstensi Firebase resmi di Extensions Hub.
Klik kartu ekstensi, lalu tinjau informasi mendetail untuk ekstensi tersebut, yang dapat mencantumkan petunjuk penggunaan spesifik dan semua tugas pra-penginstalan yang diperlukan.
Klik Instal, lalu ikuti petunjuk di layar untuk menginstal ekstensi.
Langkah 3: Selesaikan penyiapan pasca-penginstalan
Beberapa ekstensi memiliki langkah wajib atau opsional yang harus Anda selesaikan sebelum menggunakannya. Temukan petunjuk ini di halaman detail pasca-penginstalan ekstensi di dasbor Extensions pada Firebase console (link spesifik ke dasbor akan ditampilkan di terminal setelah penginstalan).
Anda juga dapat menemukan petunjuk ini dalam file POSTINSTALL.md yang disertakan di
direktori sumber ekstensi.
Membuat resource Firebase
Jika Anda mengonfigurasi ekstensi untuk menggunakan resource Firebase (koleksi Cloud Firestore, jalur Realtime Database, bucket Cloud Storage) yang belum ada, buat resource tersebut sebelum menggunakan ekstensi.
Membuat pengendali peristiwa Eventarc
Beberapa ekstensi dipublikasikan ke Eventarc saat peristiwa penting terjadi selama eksekusi. Jika ekstensi memublikasikan peristiwa, dan mengaktifkan peristiwa selama penginstalan, Anda dapat menulis fungsi yang bereaksi terhadap peristiwa tersebut dengan logika kustom Anda sendiri. Hal ini dapat berguna, misalnya, untuk memberi tahu pengguna saat tugas yang berjalan lama selesai, atau untuk pasca-pemrosesan output fungsi ekstensi.
Lihat dokumentasi ekstensi untuk daftar peristiwa (jika ada) yang dipublikasikan. Misalnya, lihat jenis peristiwa untuk ekstensi Menjalankan Pembayaran dengan Stripe.
Kemudian, lihat Pemicu peristiwa kustom untuk mengetahui informasi tentang cara menulis pengendali peristiwa Eventarc.
Menginstal beberapa instance ekstensi
Catatan: Anda dapat menginstal ekstensi yang sama beberapa kali dalam project yang sama. Setiap instance yang diinstal dapat memiliki konfigurasi yang disesuaikan sendiri dan resource ekstensinya sendiri. Anda mengidentifikasi dan merujuk ke setiap instance yang diinstal menggunakan ID instance yang bersifat unik dalam project Anda.
Anda akan diminta untuk mengonfirmasi atau mengedit ID instance dari setiap instance tambahan ekstensi yang Anda instal.
Langkah Berikutnya
Lihat detail dan konfigurasi ekstensi yang diinstal di Firebase console.
Pantau aktivitas ekstensi yang diinstal, termasuk memeriksa respons, penggunaan, dan log-nya.
Kelola ekstensi yang diinstal menggunakan Firebase console. Untuk ekstensi Firebase resmi, Anda dapat mengonfigurasi ulang atau meng-uninstal ekstensi, serta mengupdate ekstensi ke versi terbaru.
Sebagai praktik terbaik untuk semua project, pastikan Anda menyiapkan pemberitahuan anggaran untuk project Anda dan memantau dasbor Usage and billing di Firebase console.