Method: projects.webApps.getConfig

取得與指定 WebApp 相關聯的設定構件。

HTTP 要求

GET https://firebase.googleapis.com/v1beta1/{name=projects/*/webApps/*/config}

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
name

string

要下載的 WebApp 設定的資源名稱，格式如下：

projects/PROJECT_IDENTIFIER/webApps/APP_ID/config


由於 APP_ID 是專屬 ID，因此在此可使用子集合存取模式中的專屬資源，格式如下：

projects/-/webApps/APP_ID


如要進一步瞭解 PROJECT_IDENTIFIER 和 APP_ID 值，請參閱 WebApp name 欄位。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會含有以下結構的資料：

網站上單一 Firebase 應用程式的設定中繼資料。

JSON 表示法 
{
  "projectId": string,
  "appId": string,
  "databaseURL": string,
  "storageBucket": string,
  "locationId": string,
  "apiKey": string,
  "authDomain": string,
  "messagingSenderId": string,
  "measurementId": string
}
欄位
projectId

string

不可變動。使用者為 FirebaseProject 指派的專屬 ID。
appId

string

不可變動。Firebase 指派的全域專屬 WebApp ID。
databaseURL

string

預設的 Firebase 即時資料庫網址。
storageBucket

string

預設的 Cloud Storage for Firebase 儲存空間值區名稱。
locationId

string

專案預設 GCP 資源位置的 ID。位置是其中一個可用的 GCP 資源位置。

如果預設的 GCP 資源位置尚未決定，則會省略這個欄位。如要設定專案的預設 GCP 資源位置，請在將 Firebase 資源新增至專案後呼叫 defaultLocation.finalize。
apiKey

string

與 WebApp 相關聯的 API 金鑰 keyString。

請注意，這個值不是與 WebApp 相關聯的 API 金鑰的 apiKeyId (UID)。
authDomain

string

設定的 OAuth 重新導向網域 Firebase 驗證，格式如下：

PROJECT_ID.firebaseapp.com
messagingSenderId

string

用於 Firebase 雲端通訊的傳送者 ID。
measurementId

string

Google 為與 WebApp 相關聯的 Google Analytics 網站串流指派的專屬 ID。Firebase SDK 會使用此 ID 與 Google Analytics API 互動。

只有在 WebApp 連結至 Google Analytics 應用程式 + 網站資源中的網站串流時，才會顯示這個欄位。請參閱 Analytics 說明文件，進一步瞭解這個 ID 和 Google Analytics 網站串流。

如要產生 measurementId，並將 WebApp 連結至 Google Analytics 網站串流，請呼叫 projects.addGoogleAnalytics。

如果應用程式使用 Firebase JavaScript SDK 7.20.0 以上版本，Firebase 會在應用程式初始化 Analytics 時動態擷取 measurementId。您可以選擇是否要在設定物件中加入這個 ID，但在動態擷取失敗的情況下，這個 ID 可做為備用物件。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

詳情請參閱驗證總覽一文。