REST Resource: projects

资源:Firebase项目

FirebaseProject是顶级 Firebase 实体。它是 Firebase 应用、Firebase 托管站点、存储系统(Firebase 实时数据库、Cloud Firestore、Cloud Storage 存储桶)以及其他 Firebase 和 Google Cloud Platform (GCP) 资源的容器。

您可以通过调用projects.addFirebase并指定现有的GCP Project来创建FirebaseProject 。这会将 Firebase 资源添加到现有的 GCP Project中。

由于FirebaseProject实际上也是一个 GCP Project ,因此FirebaseProject具有相同的底层 GCP 标识符( projectNumberprojectId )。这样可以轻松地与 Google API 进行互操作。

JSON 表示
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
领域
name

string

项目的资源名称,格式为:

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER :项目的ProjectNumber (推荐)或其ProjectId
详细了解如何使用 Google 的AIP 2510 标准中的项目标识符。
请注意,任何响应正文中PROJECT_IDENTIFIER的值都将是ProjectId

projectId

string

仅输出。不变的。用户为项目分配的唯一标识符。

此标识符可能会出现在与项目关联的某些 Firebase 资源的 URL 或名称中,但通常应将其视为引用项目的方便别名。

projectNumber

string ( int64 format)

仅输出。不变的。 Google 为该项目分配的全球唯一的规范标识符。配置集成和/或对 Firebase 或第三方服务进行 API 调用时,请使用此标识符。

displayName

string

用户分配的项目显示名称。

resources

object ( DefaultResources )

仅输出。与项目关联的默认 Firebase 资源。

state

enum ( State )

仅输出。项目的生命周期状态。

annotations

map (key: string, value: string)

FirebaseProject的一组用户定义注释。
详细了解 Google 的AIP-128 标准中的注释。

这些注释仅适用于开发人员和客户端工具。 Firebase 服务不会改变此注释集。

包含"key": value对。示例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

etag

string

该校验和由服务器根据其他字段的值计算,并且可以与更新请求一起发送,以确保客户端在继续操作之前具有最新的值。

了解有关 Google 的AIP-154 标准中的etag更多信息。

该 etag 经过严格验证。

默认资源

与项目关联的默认资源。

JSON 表示
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
领域
hostingSite

string

仅输出。默认 Firebase 托管站点名称,格式为:

PROJECT_ID

虽然很少见,但您的projectId可能已被用作另一个项目中现有托管站点的名称(了解有关创建非默认附加站点的更多信息)。在这些情况下,您的projectId会附加一个连字符,然后是五个字母数字字符,以创建您的默认托管站点名称。例如,如果您的projectIdmyproject123 ,则您的默认托管站点名称可能是: myproject123-a5c16

realtimeDatabaseInstance

string

仅输出。默认 Firebase 实时数据库实例名称,格式为:

PROJECT_ID

尽管很少见,但您的projectId可能已用作另一个项目中现有实时数据库实例的名称(了解有关数据库分片的更多信息)。在这些情况下,您的projectId会附加一个连字符,然后是五个字母数字字符,以创建默认的实时数据库实例名称。例如,如果您的projectIdmyproject123 ,则您的默认数据库实例名称可能是: myproject123-a5c16

storageBucket

string

仅输出。默认 Cloud Storage for Firebase 存储桶,格式为:

PROJECT_ID .appspot.com

locationId

string

仅输出。项目的默认 GCP 资源位置的 ID。该位置是可用的GCP 资源位置之一。

如果默认 GCP 资源位置尚未最终确定,则省略此字段。要设置项目的默认 GCP 资源位置,请在将 Firebase 资源添加到项目后调用defaultLocation.finalize

状态

项目可能的生命周期状态。详细了解 Google AIP-216 标准中的状态。

枚举
STATE_UNSPECIFIED未指定状态。
ACTIVE该项目已启动。
DELETED该项目已被软删除。

方法

addFirebase

将 Firebase 资源添加到指定的现有Google Cloud Platform (GCP) Project

addGoogleAnalytics

将指定的FirebaseProject与现有的Google Analytics 帐户链接。

get

获取指定的FirebaseProject

getAdminSdkConfig

获取与指定FirebaseProject关联的配置工件,服务器可以使用它来简化初始化。

getAnalyticsDetails

获取当前与指定FirebaseProject关联的 Google Analytics 详细信息。

list

列出调用者可访问的每个FirebaseProject

patch

更新指定FirebaseProject的属性。

removeAnalytics

取消指定FirebaseProject与其 Google Analytics 帐户的链接。

searchApps

列出指定FirebaseProject的所有可用应用程序。