安裝 Firebase 擴充

您可以使用 Firebase 控制台或Firebase CLI (命令列介面)安裝(和管理)任何官方 Firebase 擴充功能。

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


若要安裝或管理擴充程序,您必須被指派下列角色之一: Owner 或 EditorFirebase Admin

要安裝擴展,您的專案必須採用Blaze (即用即付)計劃。雖然安裝擴充功能是免費的,但如果您的使用量超出了服務的免費套餐,您可能需要為使用 Firebase 服務或Cloud Secret Manager等雲端服務付費。

在你開始之前

  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 目錄執行擴充安裝命令。如果出現提示,請輸入參數值以自訂擴充實例。

    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 控制台的擴充儀表板中的擴充功能安裝後詳細資訊頁面中尋找這些說明(儀表板的特定連結在安裝後顯示在終端中)。

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

創建 Firebase 資源

如果您將擴充功能配置為使用尚未存在的 Firebase 資源(Cloud Firestore 集合、即時資料庫路徑、Cloud Storage 儲存桶),請在使用擴充功能之前建立它們。

建立 Eventarc 事件處理程序

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

請參閱擴充功能的文件以取得其發布的事件清單(如果有)。例如,請參閱Run Payments with Stripe 擴充的事件類型

然後,請參閱自訂事件觸發器以取得有關編寫 Eventarc 事件處理程序的資訊。

安裝多個擴充實例

您可以在同一專案中安裝多次相同擴充功能。每個安裝的實例都可以有自己的自訂配置和自己的擴充資源。您可以使用實例 ID來識別和引用每個已安裝的實例,該實例在您的專案中是唯一的。系統將提示您確認或編輯您安裝的擴充功能的每個附加實例的實例 ID。

下一步