在擴充中設定和使用參數

參數是用戶自訂擴充功能的每個已安裝實例的機制。參數就像擴展的環境變數。參數值可以自動填入（由 Firebase 安裝後提供）或使用者配置（由使用者在安裝過程中指定）。

您可以在擴充功能的函數原始碼、 extension.yaml檔案和POSTINSTALL.md檔案中引用這些參數。以下是如何引用名為PARAMETER_NAME的參數的語法：

• 在函數原始碼中，使用params模組（例如params.defineInt(" PARAMETER_NAME ") ）或process.env. PARAMETER_NAME 。

• 在extension.yaml和POSTINSTALL.md中，使用${param: PARAMETER_NAME } 。

  安裝後，Firebase 控制台會顯示POSTINSTALL.md檔案的內容，並使用已安裝實例的實際值填入所有參數參考。

自動填充參數

每個已安裝的擴充功能實例都可以自動存取 Firebase 提供的多個預設自動填入參數（請參閱下表）。這些參數值要么是 Firebase 項目的預設值（如預設儲存桶），要么是特定於擴充功能的值（如擴充功能的實例 ID）。

所有自動填入的參數值都是不可變的。它們是在專案建立或擴充安裝時設定的。

儘管 Firebase 會自動填入擴充功能的這些參數值，但 Firebase 不會在安裝過程中為使用者自動配置關聯的產品。安裝擴充功能的使用者必須在安裝之前在其項目中啟用關聯且適用的產品。例如，如果您的擴充功能涉及 Cloud Firestore，則使用者必須在其專案中設定 Cloud Firestore 。我們建議您在PREINSTALL.md檔案中通知您的使用者這些要求。

使用者配置的參數

若要使用戶能夠自訂擴充功能的每個已安裝實例，您可以要求使用者在安裝過程中指定參數值。若要請求這些值，您可以在extension.yaml檔案的params部分中設定提示。

下面是一個範例params部分，後面是描述所有可用參數欄位的表格。

# extension.yaml
...

# Parameters (environment variables) for which the user specifies values during installation
params:
  - param: DB_PATH
    label: Realtime Database path
    description: >-
      What is the Realtime Database path where you will write new text
      for sentiment analysis?
    type: string
    validationRegex: ^\S+$
    validationErrorMessage: Realtime Database path cannot contain spaces.
    example: path/to/posts
    required: true

  - param: TEXT_KEY
    label: Key for text
    description: What is the name of the key that will contain text to be analyzed?
    type: string
    default: textToAnalyze
    required: true

在extension.yaml檔案的params部分中，使用下列欄位來定義使用者配置的參數：

options:
  - label:
    value:
  - label:
    value:
  - label:
    value:

用戶配置值的驗證和錯誤訊息傳遞

當您設定string type的參數時，您需要透過參數的validationRegex欄位定義適當的正規表示式驗證。

此外，對於許多擴充功能來說，通常請求的參數值是資料庫路徑或 Cloud Storage 儲存桶。請注意，在安裝、重新配置或更新期間，擴充服務不會在輸入參數值時驗證以下內容：

• 指定的資料庫或 Cloud Storage 儲存桶是否在使用者的 Firebase 專案中設定
• 指定的資料庫路徑是否存在於使用者的資料庫中

但是，當擴充功能實際部署其資源時，如果專案中尚未設定引用的資料庫或 Cloud Storage 儲存桶，Firebase 控制台或 Firebase CLI 將顯示錯誤訊息。

我們強烈建議您在PREINSTALL檔案中通知使用者這些要求，以便他們在安裝您的擴充功能時，能夠成功安裝並按預期工作。

系統參數

系統參數控制分機資源的基本配置。由於它們旨在控制資源配置，因此無法從函數程式碼中將它們作為環境變數進行存取。

您通常不需要在extension.yaml中為這些參數宣告任何內容。它們是為每個擴充實例自動定義的，用戶有機會在安裝擴充功能時設定自訂值。

但是，如果您的擴充功能有特殊的資源需求，您可以在extension.yaml中的每個資源層級設定特定值。這些每個資源的配置設定將覆蓋使用者的擴展實例範圍的設定。例如：

resources:
- name: high_memory_function
  type: firebaseextensions.v1beta.function
  description: >-
    This function needs at least 1GB of memory!
  properties:
    httpsTrigger: {}
    runtime: nodejs18
    availableMemoryMb: 1024
- name: normal_function
  type: firebaseextensions.v1beta.function
  description: >-
    This function has no special memory requirements. It will use the
    default value, or the value of `firebaseextension.v1beta.function/memory`
  properties:
    httpsTrigger: {}
    runtime: nodejs18

可用的系統參數有：