安裝 Firebase 擴展

您可以使用 Firebase 控制台或Firebase CLI (命令行界面)安裝(和管理)任何官方 Firebase 擴展。

請務必查看 Firebase CLI 和 Firebase 控制台支持的操作的差異


要安裝或管理擴展程序,您必須被分配以下角色之一: Owner 或 EditorFirebase Admin

要安裝擴展,您的項目必須採用Blaze (即用即付)計劃。雖然安裝擴展程序是免費的,但如果您的使用量超過服務的免費套餐,您可能需要為使用 Firebase 服務或 [Cloud Secret Manager][secret-pricing] 等雲服務付費。

在你開始之前

  1. 如果您還沒有,請將 Firebase 添加到您的項目中。

  2. 如果您還沒有,請將您的項目升級到Blaze (即用即付)計劃。

  3. 安裝或更新到最新版本的 Firebase CLI。

  4. 記下您的 Firebase 項目 ID 或之前配置的項目別名。

    • 項目 ID — 從計算機上的任何位置運行firebase projects:list
    • 項目別名- 從您的本地應用程序目錄運行firebase use

第 1 步:查看有關擴展的詳細信息

此步驟是可選的,但強烈推薦。

在安裝 Firebase 擴展之前,我們建議您查看有關擴展的詳細信息,包括:

  • 擴展的工作原理、任何預安裝任務以及有關擴展的詳細信息
  • 一般識別信息和描述
  • 擴展程序的任務是否需要計費帳戶
  • 操作所需的 Google 服務 (API) 和訪問角色
  • 為擴展創建的資源(如函數)
  • 用戶可配置參數說明

查看擴展的詳細信息:

  1. 確保您已設置環境選擇了擴展

  2. 從計算機上的任何位置運行 extension-info 命令:

    firebase ext:info publisher-id/extension-id

    publisher-idextension-id參數是必需的,可以在擴展的預安裝詳細信息頁面上找到。

第 2 步:安裝擴展程序

在安裝過程中,系統會提示您查看擴展的基本規範(例如啟用的 API、創建的資源、授予的訪問權限等)。您將收到任何計費要求的通知,並且還會提示您為擴展程序的可配置參數指定值。

  1. 確保您已設置環境選擇了擴展

  2. 在本地 Firebase 目錄中,運行 extension-install 命令。如果出現提示,請輸入參數值以自定義擴展實例。

    firebase ext:install publisher-id/extension-id --project=projectId-or-alias

    publisher-idextension-id參數是必需的,可以在擴展的預安裝詳細信息頁面上找到。

    運行此命令會​​將擴展實例添加到您的擴展清單

  3. 然後,要將清單中的擴展部署到 Firebase 項目,請運行:

    firebase deploy --only extensions --project=projectId-or-alias

第 3 步:完成安裝後設置

某些擴展在使用前需要或可選步驟供您完成。在 Firebase 控制台的 Extensions 儀表板的擴展程序安裝後詳細信息頁面中找到這些說明(儀表板的特定鏈接在安裝後顯示在終端中)。

您還可以在擴展的源目錄中包含的POSTINSTALL.md文件中找到這些說明。

創建 Firebase 資源

如果您將擴展配置為使用尚不存在的 Firebase 資源(Cloud Firestore 集合、實時數據庫路徑、Cloud Storage 存儲分區),請在使用擴展之前創建它們。

創建 Eventarc 事件處理程序

當執行期間發生重要事件時,一些擴展會發佈到Eventarc 。如果擴展發布事件並且您在安裝期間啟用了事件,您可以編寫使用您自己的自定義邏輯對這些事件做出反應的函數。這可能很有用,例如,在長時間運行的任務完成時通知用戶,或對擴展函數的輸出進行後處理。

有關它發布的事件列表(如果有),請參閱擴展的文檔。

然後,請參閱自定義事件觸發器以獲取有關編寫 Eventarc 事件處理程序的信息。

安裝多個擴展實例

您可以在同一個項目中多次安裝相同的擴展。每個安裝的實例都可以有自己的自定義配置和自己的擴展資源。您可以使用實例 ID識別並引用每個已安裝的實例,該實例 ID 在您的項目中是唯一的。系統將提示您確認或編輯您安裝的每個附加擴展實例的實例 ID。

下一步

  • 在 Firebase 控制台中查看已安裝擴展程序的詳細信息和配置

  • 監控已安裝擴展程序的活動,包括檢查其運行狀況、使用情況和日誌。

  • 使用 Firebase CLI管理已安裝的擴展程序。您可以重新配置或卸載您的擴展,以及將您的擴展更新到最新版本。

  • 使用 Firebase 控制台管理已安裝的擴展程序。對於官方 Firebase 擴展,您可以重新配置或卸載擴展,以及將擴展更新到最新版本。

  • 作為所有項目的最佳做法,請務必為您的項目設置預算提醒,並在 Firebase 控制台中監控您的使用情況和計費信息中心