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 是唯一标识符,因此在这里可以使用子集合访问模式中的唯一资源,格式如下:

projects/-/webApps/APP_ID


如需详细了解 PROJECT_IDENTIFIERAPP_ID 值,请参阅 WebApp name 字段。

请求正文

请求正文必须为空。

响应正文

如果成功,响应正文将包含结构如下的数据:

单个 Web 版 Firebase 应用的配置元数据。

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 Realtime Database 网址。

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 身份验证为 OAuth 重定向配置的网域,格式如下:

PROJECT_ID.firebaseapp.com

messagingSenderId

string

用于 Firebase Cloud Messaging 的发送者 ID。

measurementId

string

WebApp 相关联的 Google Analytics 网站数据流的专属标识符,由 Google 分配。Firebase SDK 使用此 ID 与 Google Analytics API 进行交互。

仅当 WebApp 与 Google Analytics“应用 + 网站”媒体资源中的网站数据流相关联时,此字段才会显示。如需详细了解此 ID 和 Google Analytics 网站数据流,请参阅 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

如需了解详情,请参阅身份验证概览