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

有关详细信息,请参阅身份验证概述