使用者可透過參數這種機制，逐一為安裝 。參數就像是 。參數值可以是 自動填入 (由 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檔案，並將 已安裝執行個體的 actual 值。
自動填入的參數
每個已安裝的擴充功能執行個體都會自動獲得 Firebase 提供的預設自動填入參數 (請參閱下表 )。這些參數值是 Firebase 的預設值 專案 (例如 default Storage 值區) 或特定副檔名 (例如 擴充功能的執行個體 ID)。
所有自動填入的參數值都無法變更。這些 Pod 會在 專案建立或安裝擴充功能
雖然 Firebase 會為擴充功能自動填入這些參數值
Firebase 不會在
安裝。安裝擴充功能時，使用者必須啟用
和適用的產品。舉例來說
您的擴充功能牽涉到 Cloud Firestore，使用者必須
設定 Cloud Firestore
專案。建議您向使用者
PREINSTALL.md
檔案。
| 自動填入參數的參考資料 | 說明 | 參數值 (由 Firebase 提供) |
|---|---|---|
| 來自 Firebase 專案中具有預設值的參數 | ||
PROJECT_ID |
擴充功能所屬 Firebase 專案的專屬 ID 已安裝 |
一般格式：
範例值： |
DATABASE_URL |
Firebase 專案的預設即時資料庫執行個體網址 |
一般格式：
範例值： |
DATABASE_INSTANCE |
Firebase 專案的預設即時資料庫執行個體名稱 這個值通常與專案 ID 相同，或者結尾是
|
一般格式：
範例值： |
STORAGE_BUCKET |
Firebase 專案的預設 Cloud Storage 值區名稱 |
一般格式：
範例值： |
| 安裝擴充功能時，含有預設值的參數 | ||
EXT_INSTANCE_ID |
已安裝擴充功能執行個體的專屬 ID 這個值會產生
|
第 1 個安裝的執行個體的一般化格式 (已自動指派)
由 Firebase 提供；不得在安裝期間使用者修改)：
範例值： 安裝第 2 版以上執行個體的通用格式
(由 Firebase 自動指派；可以由使用者修改
安裝期間)：
範例值： |
使用者設定的參數
如要讓使用者能夠自訂擴充功能安裝的每個執行個體，您可以
要求使用者在安裝期間指定參數值。如何要求這些
請在 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 區段中，使用下列欄位
來定義使用者設定的參數：
| 欄位 | 類型 | 說明 | ||||
|---|---|---|---|---|---|---|
param(必填) |
字串 | 參數名稱 | ||||
label(必填) |
字串 |
參數的簡短說明 並在使用者要求輸入參數的 值 |
||||
description(選答) |
字串 |
參數的詳細說明 並在使用者要求輸入參數的 值 支援 Markdown | ||||
type(選答) |
字串 |
使用者設定參數值方式的輸入機制 (適用於 例如直接輸入文字或從下拉式清單中選取) 有效的值包括：
如果省略這個欄位，參數會預設為 |
||||
options(如果參數 type 則為必要欄位)
是 select 或 multiSelect)
|
list |
使用者可以選取的值清單 將
「 |
||||
resourceType(如果參數 type 則為必要欄位)
selectResource)
|
字串 |
提示使用者選取的 Firebase 資源類型。 目前只有 Cloud Storage 值區支援資源選取器：
系統會忽略不明的 |
||||
example(選答) |
字串 |
參數的範例值 |
||||
validationRegex(選答) (僅適用於 type 參數
string)
|
字串 |
用於驗證參數使用者設定值的規則運算式字串 規則運算式使用 Go 程式庫編譯：RE2 如要進一步瞭解驗證，請參閱 驗證和錯誤 訊息。 |
||||
validationErrorMessage(選答) |
字串 |
如果
如要進一步瞭解錯誤訊息，請參閱 驗證和錯誤 訊息。 |
||||
default(選答) |
字串 |
當使用者離開參數的 值空白 在適用情況下，您可以指定
自動填入的參數值
值 (例如， |
||||
required(選答) |
布林值 |
定義使用者是否可在操作時提交空白字串 要求輸入參數值 如果省略 |
||||
immutable(選答) |
布林值 |
定義使用者能否在 安裝 (例如 重新設定 擴充功能) 如果省略
注意：如果您定義了
「位置」
已部署函式的參數
您應該在參數中加入這個 |
使用者設定值的驗證和錯誤訊息
使用 string 的 type 設定參數時，必須定義
透過參數的
validationRegex 欄位中填入資料。
此外，許多擴充功能的常見要求參數值是資料庫 路徑或 Cloud Storage 值區在安裝、重新設定或 更新後，擴充功能服務不會驗證以下項目： 參數值 entry 的時間：
- 指定的資料庫或 Cloud Storage 值區是在 使用者的 Firebase 專案
- 指定的資料庫路徑是否存在使用者的資料庫中
然而，當擴充功能實際部署其資源時 如果發生以下情況，Firebase 控制台或 Firebase CLI 將顯示錯誤訊息 您尚未在專案中設定參照的資料庫或 Cloud Storage 值區。
強烈建議您通知使用
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
可用的系統參數如下：
| 名稱 | 標籤 (容易理解) | properties 中的對應欄位 |
說明 |
|---|---|---|---|
| firebaseextensions.v1beta.function/location | 位置 | location |
應將 Cloud Functions 部署至哪個區域？ |
| firebaseextensions.v1beta.function/memory | 函式記憶體 | memory |
每個函式應分配多少 MB 記憶體？ |
| firebaseextensions.v1beta.function/timeoutSeconds | 函式逾時 | timeout |
逾時前應執行多少秒函式？ |
| firebaseextensions.v1beta.function/vpcConnectoregressSettings | 虛擬私有雲連接器輸出 | vpcConnectorEgressSettings |
在設定虛擬私有雲連接器時控管傳出流量 |
| firebaseextensions.v1beta.function/vpcConnector | 虛擬私有雲連接器 | vpcConnector |
將 Cloud Functions 連線至指定的虛擬私有雲連接器。 |
| firebaseextensions.v1beta.function/minInstances | 函式執行個體數量下限 | minInstances |
此函式同時執行的最低執行個體數量下限 |
| firebaseextensions.v1beta.function/maxInstances | 函式執行個體上限 | maxInstances |
此函式一次執行的執行個體數量上限 |
| firebaseextensions.v1beta.function/ingressSettings | 輸入設定 | ingressSettings |
控管接收下列來源的流量 |
| firebaseextensions.v1beta.function/labels | 標籤 | labels |
要套用至擴充功能中所有資源的標籤 |