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 (base de datos en tiempo real de Firebase, Cloud Firestore, cubos de almacenamiento en la nube) 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

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

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

projectNumber

string ( int64 format)

Solo salida. Inmutable. El identificador canónico global único asignado por Google para el Proyecto. Utilice este identificador cuando configure integraciones o realice llamadas API a Firebase o servicios de terceros.

displayName

string

El nombre de visualización asignado por el usuario del Proyecto.

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 .
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 mutarán este conjunto de anotaciones.

Un objeto que contiene una lista de "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 se puede enviar 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.

Este etag está fuertemente validado.

Recursos predeterminados

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 predeterminado del sitio de alojamiento de Firebase, en el formato:

PROJECT_ID

Aunque es raro, es posible que su projectId ya se use como el nombre de un sitio de hospedaje existente en otro proyecto (obtenga más información sobre cómo crear sitios adicionales no predeterminados). En estos casos, su projectId de proyecto se agrega con un guión y luego con cinco caracteres alfanuméricos para crear su nombre de sitio de hospedaje predeterminado. Por ejemplo, si su projectId es myproject123 , el nombre de su sitio de alojamiento predeterminado 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 raro, es posible que su projectId ya se use como el nombre de 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, su projectId se agrega con un guión y luego con cinco caracteres alfanuméricos para crear su nombre de instancia predeterminado de Realtime Database. Por ejemplo, si su projectId es myproject123 , su nombre de instancia de base de datos predeterminado 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 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 de recursos de GCP predeterminada aún no se ha finalizado. Para establecer la ubicación de recursos de GCP predeterminada de un proyecto, llame 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 se ha 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.