REST Resource: projects

Recurso: FirebaseProject

Una FirebaseProject es la entidad de Firebase de nivel superior. Es el contenedor de las apps de Firebase, los sitios de Firebase Hosting, los sistemas de almacenamiento (Firebase Realtime Database, Cloud Firestore, buckets de Cloud Storage) y otros recursos de Firebase y Google Cloud Platform (GCP).

Crea un FirebaseProject llamando a projects.addFirebase y especificando un GCP existente Project. Esto agrega recursos de Firebase al Project de GCP existente.

Dado que un FirebaseProject en realidad también es un Project de GCP, un FirebaseProject tiene los mismos identificadores de GCP subyacentes (projectNumber y projectId). Esto facilita la interoperabilidad con las APIs de Google.

Representación JSON
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
Campos
name

string

El nombre del recurso del proyecto, en el formato:

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER: El ProjectNumber (recomendado) del proyecto o su ProjectId.
Obtén más información para usar identificadores de proyectos en el estándar AIP 2510 de Google.
Ten en cuenta que el valor de PROJECT_IDENTIFIER en cualquier cuerpo de respuesta será el ProjectId.

projectId

string

Solo salida. Inmutable. Un identificador único asignado por el usuario para el Proyecto.

Este identificador puede aparecer en las URL o los nombres de algunos recursos de Firebase asociados con el Proyecto, pero, por lo general, debe considerarse un alias de conveniencia para referirse al Proyecto.

projectNumber

string (int64 format)

Solo salida. Inmutable. El identificador canónico del Proyecto asignado por Google y único a nivel global. Úsalo cuando configures integraciones o realices llamadas a las APIs de Firebase o servicios de terceros.

displayName

string

El nombre visible del Proyecto asignado por el usuario.

resources

object (DefaultResources)

Solo salida. Los recursos predeterminados de Firebase asociados con el Proyecto.

state

enum (State)

Solo salida. El estado del ciclo de vida del Proyecto.

annotations

map (key: string, value: string)

Un conjunto de anotaciones definidas por el usuario para FirebaseProject.
Obtén más información sobre las anotaciones según el estándar AIP-128 de Google.

Estas anotaciones están destinadas únicamente a los desarrolladores y a las herramientas del cliente. Los servicios de Firebase no cambiarán este conjunto de anotaciones.

Un objeto que contiene una lista de pares "key": value. Ejemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

etag

string

El servidor calcula esta suma de comprobación en función del valor de otros campos, y es posible que se envíe con solicitudes de actualización para garantizar que el cliente tenga un valor actualizado antes de continuar.

Obtén más información sobre etag según el estándar AIP-154 de Google.

Esta ETag tiene una validación sólida.

DefaultResources

Los recursos predeterminados asociados con el Proyecto.

Representación JSON
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
Campos
hostingSite

string

Solo salida. El nombre del sitio predeterminado de Firebase Hosting, en el formato:

PROJECT_ID

Aunque es poco frecuente, es posible que tu projectId ya se use como nombre de un sitio de Hosting existente en otro proyecto (obtén más información para crear sitios adicionales no predeterminados). En estos casos, se agrega un guion a tu projectId y, luego, cinco caracteres alfanuméricos para crear el nombre predeterminado del sitio de Hosting. Por ejemplo, si projectId es myproject123, el nombre predeterminado del sitio de Hosting podría ser myproject123-a5c16.

realtimeDatabaseInstance

string

Solo salida. El nombre predeterminado de la instancia de Firebase Realtime Database, en el formato:

PROJECT_ID

Aunque es poco frecuente, es posible que projectId ya se use como nombre de una instancia existente de Realtime Database en otro proyecto (obtén más información sobre la fragmentación de bases de datos). En estos casos, se agrega un guion a tu projectId y, luego, cinco caracteres alfanuméricos para crear el nombre predeterminado de la instancia de Realtime Database. Por ejemplo, si projectId es myproject123, el nombre predeterminado de la instancia de base de datos podría ser myproject123-a5c16.

storageBucket

string

Solo salida. El depósito de almacenamiento predeterminado de Cloud Storage para Firebase, en el formato:

PROJECT_ID.appspot.com

locationId

string

Solo salida. El ID de la ubicación predeterminada de los recursos de GCP del proyecto. La ubicación es una de las ubicaciones de recursos de GCP disponibles.

Este campo se omite si aún no se finalizó la ubicación predeterminada de los recursos de GCP. Para configurar la ubicación predeterminada de los recursos de GCP de un proyecto, llama a defaultLocation.finalize después de agregar los recursos de Firebase al proyecto.

Estado

Los posibles estados del ciclo de vida del Proyecto. Obtenga más información sobre los estados según el estándar AIP-216 de Google.

Enums
STATE_UNSPECIFIED Estado sin especificar.
ACTIVE El proyecto está activo.
DELETED El proyecto se borró de forma no definitiva.

Métodos

addFirebase

Agrega recursos de Firebase al Project existente de Google Cloud Platform (GCP) que se especificó.

addGoogleAnalytics

Vincula el FirebaseProject especificado con una cuenta de Google Analytics existente.

get

Obtiene el FirebaseProject especificado.

getAdminSdkConfig

Obtiene el artefacto de configuración asociado con el FirebaseProject especificado, que los servidores pueden usar para simplificar la inicialización.

getAnalyticsDetails

Obtiene los detalles de Google Analytics asociados actualmente con el FirebaseProject especificado.

list

Enumera cada FirebaseProject accesible para el llamador.

patch

Actualiza los atributos del FirebaseProject especificado.

removeAnalytics

Desvincula el FirebaseProject especificado de su cuenta de Google Analytics.

searchApps

Muestra una lista de todas las apps disponibles para el FirebaseProject especificado.