Method: projects.webApps.getConfig

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

HTTP請求

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

URL 使用gRPC 轉碼語法。

路徑參數

參數
name

string

若要下載的WebApp配置的資源名稱,格式為:

projects/ PROJECT_IDENTIFIER /webApps/ APP_ID /config


由於APP_ID是唯一標識符,因此此處可以使用來自子集合的唯一資源存取模式,格式為:

projects/-/webApps/ APP_ID


有關PROJECT_IDENTIFIERAPP_ID值的詳細信息,請參閱WebApp name欄位。

請求正文

請求內文必須為空。

響應體

如果成功,回應正文包含具有以下結構的資料:

單一 Firebase Web 應用程式的配置元資料。

JSON 表示
{
  "projectId": string,
  "appId": string,
  "databaseURL": string,
  "storageBucket": string,
  "locationId": string,
  "apiKey": string,
  "authDomain": string,
  "messagingSenderId": string,
  "measurementId": string
}
領域
projectId

string

不變的。使用者為FirebaseProject分配的唯一識別碼。

appId

string

不變的。 Firebase 為WebApp指派的全域唯一識別碼。

databaseURL

string

預設 Firebase 即時資料庫 URL。

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

Firebase Auth 為 OAuth 重定向配置的網域,格式如下:

PROJECT_ID .firebaseapp.com

messagingSenderId

string

用於 Firebase 雲端訊息傳遞的寄件者 ID。

measurementId

string

WebApp關聯的 Google Analytics 網路流的唯一 Google 分配識別碼。 Firebase SDK 使用此 ID 與 Google Analytics API 互動。

只有當WebApp連結到 Google Analytics 應用程式 + Web 屬性中的網路流時,此欄位才會出現。在Analytics 文件中了解有關此 ID 和 Google Analytics 網路流的更多資訊。

要產生measurementId並將WebApp與Google Analytics網路流鏈接,請呼叫projects.addGoogleAnalytics

對於使用 Firebase JavaScript SDK v7.20.0 及更高版本的應用,Firebase 會在您的應用程式初始化 Analytics 時動態取得measurementId 。在組態物件中包含此 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

有關詳細信息,請參閱身份驗證概述