REST Resource: projects

Recurso: Proyecto Firebase

Un FirebaseProject es la entidad de Firebase de nivel superior. Es el contenedor de aplicaciones de Firebase, sitios de alojamiento de Firebase, sistemas de almacenamiento (Firebase Realtime Database, Cloud Firestore, depósitos de Cloud Storage) y otros recursos de Firebase y Google Cloud Platform (GCP).

Para crear un FirebaseProject , llama a projects.addFirebase y especifica un Project de GCP existente . Esto agrega recursos de Firebase al Project GCP existente.

Dado que un FirebaseProject también es en realidad un Project de GCP, un FirebaseProject tiene los mismos identificadores de GCP subyacentes ( projectNumber y projectId ). Esto permite una fácil interoperabilidad con las API 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 del proyecto (recomendado) o su ProjectId .
Obtenga más información sobre el uso de identificadores de proyectos en el estándar AIP 2510 de Google.
Tenga en cuenta que el valor de PROJECT_IDENTIFIER en cualquier cuerpo de respuesta será ProjectId .

projectId

string

Sólo salida. Inmutable. Un identificador único asignado por el usuario para el Proyecto.

Este identificador puede aparecer en las URL o nombres de algunos recursos de Firebase asociados con el Proyecto, pero generalmente debe tratarse como un alias conveniente para hacer referencia al Proyecto.

projectNumber

string ( int64 format)

Sólo salida. Inmutable. El identificador canónico globalmente único asignado por Google para el Proyecto. Utilice este identificador al configurar integraciones y/o realizar llamadas API a Firebase o servicios de terceros.

displayName

string

El nombre para mostrar del proyecto asignado por el usuario.

resources

object ( DefaultResources )

Sólo salida. Los recursos predeterminados de Firebase asociados con el proyecto.

state

enum ( State )

Sólo 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 .
Obtenga más información sobre las anotaciones en el estándar AIP-128 de Google.

Estas anotaciones están destinadas únicamente a desarrolladores y herramientas del lado del cliente. Los servicios de Firebase no modificará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 verificación en función del valor de otros campos y puede enviarse con solicitudes de actualización para garantizar que el cliente tenga un valor actualizado antes de continuar.

Obtenga más información sobre etag en el estándar AIP-154 de Google.

Esta etiqueta electrónica está fuertemente validada.

Recursos predeterminados

Los recursos predeterminados asociados con el Proyecto.

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

string

Sólo salida. El nombre predeterminado del sitio de Firebase Hosting, en el formato:

PROJECT_ID

Aunque es poco común, es posible que su projectId ya se utilice como nombre de un sitio de hosting existente en otro proyecto (obtenga más información sobre cómo crear sitios adicionales no predeterminados). En estos casos, a su projectId se le agrega un guión y luego cinco caracteres alfanuméricos para crear el nombre de su sitio de alojamiento predeterminado. Por ejemplo, si su projectId es myproject123 , el nombre de su sitio de alojamiento predeterminado podría ser: myproject123-a5c16

realtimeDatabaseInstance

string

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

PROJECT_ID

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

storageBucket

string

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

PROJECT_ID .appspot.com

locationId

string

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

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

Estado

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

Enumeraciones
STATE_UNSPECIFIED Estado no especificado.
ACTIVE El Proyecto está activo.
DELETED El proyecto ha sido eliminado temporalmente.

Métodos

addFirebase

 Agrega recursos de Firebase al Project de Google Cloud Platform (GCP) existente especificado.

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 actualmente asociados con el FirebaseProject especificado.

list

 Enumera cada FirebaseProject accesible para la persona que llama.

patch

 Actualiza los atributos del FirebaseProject especificado.

removeAnalytics

 Desvincula el FirebaseProject especificado de su cuenta de Google Analytics.

searchApps

 Enumera todas las aplicaciones disponibles para el FirebaseProject especificado.