安裝 Firebase 擴充功能

您可以使用 Firebase 主控台、Firebase CLI (指令列介面) 或自動產生的 SDK 安裝 (及管理) 任何官方 Firebase 擴充功能。

請務必查看各安裝方法支援的動作差異。



如要安裝或管理擴充功能，您必須具備下列任一角色：擁有者或編輯者或Firebase 管理員。

如要安裝擴充功能，專案必須採用 Blaze (即付即用) 方案。雖然安裝擴充功能不需付費，但如果您使用 Firebase 服務或 Cloud 服務 (例如 Cloud Secret Manager) 的用量超出免費方案的配額，可能就會產生費用。

事前準備

如果您尚未將 Firebase 新增至專案，請將 Firebase 專案升級至 Blaze (即付即用) 方案。

步驟 1：查看擴充功能的詳細資訊

這是選用步驟，但強烈建議執行。

安裝 Firebase Extension 前，建議您詳閱擴充功能的詳細資訊，包括：

  • 擴充功能的運作方式、任何預先安裝工作，以及擴充功能的詳細資料
  • 一般識別資訊和說明
  • 擴充功能的作業是否需要帳單帳戶
  • 操作所需的 Google 服務 (API) 和存取權角色
  • 為擴充功能建立的資源 (例如函式)
  • 使用者可設定參數的說明

如要查看擴充功能的詳細資訊：

  1. 在 Extensions Hub 中瀏覽官方 Firebase 擴充功能。

  2. 按一下擴充功能的資訊卡，即可執行下列操作：

步驟 2：安裝擴充功能

在安裝過程中，系統會提示您查看擴充功能的基本規格 (例如已啟用的 API、已建立的資源、已授予的存取權等)。系統會通知您任何帳單相關規定，並提示您指定擴充功能的可設定參數值。

  1. 在 Extensions Hub 中瀏覽官方 Firebase 擴充功能。

  2. 按一下擴充功能的資訊卡，然後查看擴充功能的詳細資訊，其中可能會提供特定使用說明和任何安裝前作業。

  3. 按一下「安裝」，然後按照畫面上的指示安裝擴充功能。

步驟 3：完成安裝後的設定

部分擴充功能需要先完成必要或選用步驟，才能使用。在 Firebase 主控台的 Extensions 資訊主頁中，找到擴充功能的安裝後詳細資料頁面，即可找到這些操作說明 (安裝完成後，終端機會顯示前往資訊主頁的特定連結)。

您也可以在擴充功能的來源目錄中，找到包含這些操作說明的 POSTINSTALL.md 檔案。

建立 Firebase 資源

如果您已將擴充功能設定為使用尚不存在的 Firebase 資源 (Cloud Firestore 集合、Realtime Database 路徑、Cloud Storage 桶)，請先建立這些資源，再使用擴充功能。

建立 Eventarc 事件處理常式

在執行期間發生重要事件時，部分擴充功能會發布至 Eventarc。如果擴充功能會發布事件，且您在安裝期間啟用了事件，您可以編寫函式，以自訂邏輯回應這些事件。這在某些情況下很實用，例如在長時間執行的工作完成時通知使用者，或是在擴充功能函式的輸出內容後處理。

請參閱擴充功能的說明文件，瞭解該擴充功能發布的事件清單 (如有)。例如，請參閱「使用 Stripe 擴充功能執行付款功能的事件類型」。

接著，請參閱「自訂事件觸發條件」，瞭解如何編寫 Eventarc 事件處理常式。

安裝多個擴充功能執行個體

您可以在同一個專案中多次安裝相同的擴充功能。每個已安裝的例項都可以有專屬的自訂設定和擴充功能資源。您可以使用執行個體 ID 來識別及參照每個已安裝的執行個體，而這項 ID 在專案中是唯一的。

系統會提示您確認或編輯所安裝擴充功能的每個額外執行個體的執行個體 ID。

後續步驟