可傳遞給 initializeApp() 的可用選項。
簽名:
export interface AppOptions
屬性
屬性 | 類型 | 說明 |
---|---|---|
憑證 | 憑證 | 用於驗證 Admin SDK 的 Credential 物件。如需詳細說明文件和程式碼範例,請參閱「初始化 SDK」。 |
databaseAuthVariableOverride | 物件 | 空值 | Admin SDK 讀取或寫入即時資料庫時,要在即時資料庫規則中做為 auth 變數的物件。這可讓您縮小 Admin SDK 的預設完整讀取和寫入權限。您可以傳遞 null ,做為未經驗證的用戶端執行操作。如需詳細說明文件和程式碼範例,請參閱「以有限權限進行驗證」。 |
databaseURL | 字串 | 要讀取及寫入資料的即時資料庫網址。 |
httpAgent | 代理程式 | 發出 HTTP 呼叫時使用的 HTTP 代理程式。所有會產生 REST 呼叫的服務 (例如 auth 、messaging 、projectManagement ) 都會使用這個代理程式執行個體。即時資料庫和 Firestore 採用其他與後端伺服器通訊的方式,因此不會使用這個 HTTP 代理程式。Credential 執行個體也不會使用這個 HTTP 代理程式,而是支援在對應的工廠方法中指定 HTTP 代理程式。 |
projectId | 字串 | 與應用程式相關聯的 Google Cloud 專案 ID。 |
serviceAccountId | 字串 | 要用於簽署自訂權杖的服務帳戶 ID。您可以在服務帳戶 JSON 檔案的 client_email 欄位中找到這項資訊。 |
storageBucket | 字串 | 用來儲存應用程式資料的 Google Cloud Storage 值區名稱。請僅使用值區名稱,不要加上任何前置字串或附加文字 (「請勿」在名稱前加上「gs://」)。 |
AppOptions.credential
用於驗證 Admin SDK 的 Credential 物件。
如需詳細的說明文件和程式碼範例,請參閱「初始化 SDK」。
簽名:
credential?: Credential;
AppOptions.databaseAuthVariableOverride
Admin SDK 讀取或寫入即時資料庫時,要在即時資料庫規則中做為 auth 變數的物件。這樣一來,您就能將 Admin SDK 的範圍縮小至 Admin SDK 的預設完整讀取和寫入權限。
您可以傳遞 null
,做為未驗證的用戶端使用。
如需詳細說明文件和程式碼範例,請參閱「以有限權限進行驗證」。
簽名:
databaseAuthVariableOverride?: object | null;
AppOptions.databaseURL
要讀取及寫入資料的即時資料庫網址。
簽名:
databaseURL?: string;
AppOptions.httpAgent
發出 HTTP 呼叫時使用的 HTTP 代理程式。所有發出 REST 呼叫的服務 (例如 auth
、messaging
、projectManagement
) 都會使用這個代理程式執行個體。
即時資料庫和 Firestore 採用其他與後端伺服器通訊的方式,因此不會使用這個 HTTP 代理程式。Credential
執行個體也不會使用這個 HTTP 代理程式,而是支援在對應的工廠方法中指定 HTTP 代理程式。
簽名:
httpAgent?: Agent;
AppOptions.projectId
與應用程式相關聯的 Google Cloud 專案 ID。
簽名:
projectId?: string;
AppOptions.serviceAccountId
要用於簽署自訂權杖的服務帳戶 ID。您可以在服務帳戶 JSON 檔案的 client_email
欄位中找到這項資訊。
簽名:
serviceAccountId?: string;
AppOptions.storageBucket
用來儲存應用程式資料的 Google Cloud Storage 值區名稱。請僅使用值區名稱,不要加上任何前置字串或附加文字 (「請勿」在名稱前加上「gs://」)。
簽名:
storageBucket?: string;