REST Resource: projects

Ressource : FirebaseProject

Un FirebaseProject est l'entité Firebase de niveau supérieur. Il s'agit du conteneur pour les applications Firebase, les sites d'hébergement Firebase, les systèmes de stockage (Firebase Realtime Database, Cloud Firestore, compartiments Cloud Storage) et d'autres ressources Firebase et Google Cloud Platform (GCP).

Vous créez un FirebaseProject en appelant projects.addFirebase et en spécifiant un Project GCP existant . Cela ajoute des ressources Firebase au Project GCP existant.

Puisqu'un FirebaseProject est en fait également un Project GCP , un FirebaseProject a les mêmes identifiants GCP sous-jacents ( projectNumber et projectId ). Cela permet une interopérabilité facile avec les API Google.

Représentation JSON
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
Des champs
name

string

Le nom de la ressource du projet, au format :

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER : le ProjectNumber du Projet (recommandé) ou son ProjectId .
En savoir plus sur l'utilisation des identifiants de projet dans la norme AIP 2510 de Google .
Notez que la valeur de PROJECT_IDENTIFIER dans tout corps de réponse sera ProjectId .

projectId

string

Sortie uniquement. Immuable. Un identifiant unique attribué par l'utilisateur pour le projet.

Cet identifiant peut apparaître dans les URL ou les noms de certaines ressources Firebase associées au projet, mais il doit généralement être traité comme un alias pratique pour référencer le projet.

projectNumber

string ( int64 format)

Sortie uniquement. Immuable. L'identifiant canonique unique au monde, attribué par Google pour le projet. Utilisez cet identifiant lors de la configuration des intégrations et/ou des appels d'API vers Firebase ou des services tiers.

displayName

string

Le nom d'affichage attribué par l'utilisateur au projet.

resources

object ( DefaultResources )

Sortie uniquement. Les ressources Firebase par défaut associées au projet.

state

enum ( State )

Sortie uniquement. L’état du cycle de vie du projet.

annotations

map (key: string, value: string)

Un ensemble d'annotations définies par l'utilisateur pour le FirebaseProject .
En savoir plus sur les annotations dans la norme AIP-128 de Google .

Ces annotations sont destinées uniquement aux développeurs et aux outils côté client. Les services Firebase ne modifieront pas cet ensemble d'annotations.

Un objet contenant une liste de paires "key": value . Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" } .

etag

string

Cette somme de contrôle est calculée par le serveur en fonction de la valeur d'autres champs et peut être envoyée avec des demandes de mise à jour pour garantir que le client dispose d'une valeur à jour avant de continuer.

Apprenez-en davantage sur etag dans la norme AIP-154 de Google .

Cette étiquette est fortement validée.

Ressources par défaut

Les ressources par défaut associées au projet.

Représentation JSON
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
Des champs
hostingSite

string

Sortie uniquement. Le nom du site Firebase Hosting par défaut, au format :

PROJECT_ID

Bien que cela soit rare, votre projectId peut déjà être utilisé comme nom d'un site d'hébergement existant dans un autre projet (en savoir plus sur la création de sites supplémentaires , autres que ceux par défaut). Dans ces cas, votre projectId est suivi d'un trait d'union puis de cinq caractères alphanumériques pour créer votre nom de site d'hébergement par défaut. Par exemple, si votre projectId est myproject123 , le nom de votre site d'hébergement par défaut peut être : myproject123-a5c16

realtimeDatabaseInstance

string

Sortie uniquement. Nom de l'instance de base de données en temps réel Firebase par défaut, au format :

PROJECT_ID

Bien que cela soit rare, votre projectId peut déjà être utilisé comme nom d'une instance de base de données en temps réel existante dans un autre projet (en savoir plus sur le partitionnement de base de données ). Dans ces cas, votre projectId est suivi d'un trait d'union puis de cinq caractères alphanumériques pour créer votre nom d'instance de base de données en temps réel par défaut. Par exemple, si votre projectId est myproject123 , le nom de votre instance de base de données par défaut peut être : myproject123-a5c16

storageBucket

string

Sortie uniquement. Le bucket de stockage Cloud Storage pour Firebase par défaut, au format :

PROJECT_ID .appspot.com

locationId

string

Sortie uniquement. ID de l'emplacement des ressources GCP par défaut du projet. L'emplacement est l'un des emplacements de ressources GCP disponibles.

Ce champ est omis si l'emplacement des ressources GCP par défaut n'a pas encore été finalisé. Pour définir l'emplacement des ressources GCP par défaut d'un projet, appelez defaultLocation.finalize après avoir ajouté des ressources Firebase au projet.

État

Les états possibles du cycle de vie du projet. Apprenez-en davantage sur les états dans la norme AIP-216 de Google .

Énumérations
STATE_UNSPECIFIED État non précisé.
ACTIVE Le projet est actif.
DELETED Le projet a été supprimé de manière logicielle.

Méthodes

addFirebase

Ajoute des ressources Firebase au Project Google Cloud Platform (GCP) existant spécifié.

addGoogleAnalytics

Lie le FirebaseProject spécifié à un compte Google Analytics existant .

get

Obtient le FirebaseProject spécifié.

getAdminSdkConfig

Obtient l'artefact de configuration associé au FirebaseProject spécifié, qui peut être utilisé par les serveurs pour simplifier l'initialisation.

getAnalyticsDetails

Obtient les détails Google Analytics actuellement associés au FirebaseProject spécifié.

list

Répertorie chaque FirebaseProject accessible à l'appelant.

patch

Met à jour les attributs du FirebaseProject spécifié.

removeAnalytics

Dissocie le FirebaseProject spécifié de son compte Google Analytics.

searchApps

Répertorie toutes les applications disponibles pour le FirebaseProject spécifié.