REST Resource: projects

Risorsa: FirebaseProject

Un FirebaseProject è l'entità Firebase di primo livello. È il contenitore per app Firebase, siti di hosting Firebase, sistemi di archiviazione (Firebase Realtime Database, Cloud Firestore, bucket Cloud Storage) e altre risorse Firebase e Google Cloud Platform (GCP).

Puoi creare un FirebaseProject chiamando projects.addFirebase e specificando un Project GCP esistente . Ciò aggiunge risorse Firebase al Project GCP esistente.

Poiché un FirebaseProject è in realtà anche un Project GCP, un FirebaseProject ha gli stessi identificatori GCP sottostanti ( projectNumber e projectId ). Ciò consente una facile interoperabilità con le API di Google.

Rappresentazione JSON
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
Campi
name

string

Il nome della risorsa del progetto, nel formato:

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER : il ProjectNumber del progetto (consigliato) o il suo ProjectId .
Ulteriori informazioni sull'utilizzo degli identificatori di progetto nello standard AIP 2510 di Google.
Tieni presente che il valore per PROJECT_IDENTIFIER in qualsiasi corpo della risposta sarà ProjectId .

projectId

string

Solo uscita. Immutabile. Un identificatore univoco assegnato dall'utente per il progetto.

Questo identificatore può apparire negli URL o nei nomi di alcune risorse Firebase associate al progetto, ma generalmente dovrebbe essere trattato come un alias di convenienza per fare riferimento al progetto.

projectNumber

string ( int64 format)

Solo uscita. Immutabile. L'identificatore canonico globalmente univoco assegnato da Google per il progetto. Utilizza questo identificatore quando configuri integrazioni e/o effettui chiamate API a Firebase o servizi di terze parti.

displayName

string

Il nome visualizzato del progetto assegnato dall'utente.

resources

object ( DefaultResources )

Solo uscita. Le risorse Firebase predefinite associate al progetto.

state

enum ( State )

Solo uscita. Lo stato del ciclo di vita del progetto.

annotations

map (key: string, value: string)

Una serie di annotazioni definite dall'utente per FirebaseProject .
Ulteriori informazioni sulle annotazioni nello standard AIP-128 di Google.

Queste annotazioni sono destinate esclusivamente agli sviluppatori e agli strumenti lato client. I servizi Firebase non modificheranno questo set di annotazioni.

Un oggetto contenente un elenco di coppie "key": value . Esempio: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

etag

string

Questo checksum viene calcolato dal server in base al valore di altri campi e può essere inviato con richieste di aggiornamento per garantire che il client disponga di un valore aggiornato prima di procedere.

Ulteriori informazioni etag nello standard AIP-154 di Google.

Questo etag è fortemente convalidato.

DefaultResources

Le risorse predefinite associate al progetto.

Rappresentazione JSON
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
Campi
hostingSite

string

Solo uscita. Il nome del sito di hosting Firebase predefinito, nel formato:

PROJECT_ID

Sebbene raro, il tuo projectId potrebbe già essere utilizzato come nome per un sito di hosting esistente in un altro progetto (ulteriori informazioni sulla creazione di siti aggiuntivi non predefiniti). In questi casi, al tuo projectId vengono aggiunti un trattino e poi cinque caratteri alfanumerici per creare il nome del sito di hosting predefinito. Ad esempio, se il tuo projectId è myproject123 , il nome del tuo sito di hosting predefinito potrebbe essere: myproject123-a5c16

realtimeDatabaseInstance

string

Solo uscita. Il nome dell'istanza predefinita di Firebase Realtime Database, nel formato:

PROJECT_ID

Sebbene raro, il tuo projectId potrebbe già essere utilizzato come nome per un'istanza di Realtime Database esistente in un altro progetto (ulteriori informazioni sullo sharding del database ). In questi casi, al tuo projectId viene aggiunto un trattino e poi cinque caratteri alfanumerici per creare il nome dell'istanza di Realtime Database predefinito. Ad esempio, se il tuo projectId è myproject123 , il nome dell'istanza del database predefinito potrebbe essere: myproject123-a5c16

storageBucket

string

Solo uscita. Il bucket di archiviazione predefinito di Cloud Storage for Firebase, nel formato:

PROJECT_ID .appspot.com

locationId

string

Solo uscita. L'ID della posizione della risorsa GCP predefinita del progetto. La posizione è una delle posizioni delle risorse GCP disponibili.

Questo campo viene omesso se la posizione predefinita della risorsa GCP non è stata ancora finalizzata. Per impostare la posizione predefinita delle risorse GCP di un progetto, chiama defaultLocation.finalize dopo aver aggiunto le risorse Firebase al progetto.

Stato

I possibili stati del ciclo di vita del Progetto. Ulteriori informazioni sugli stati nello standard AIP-216 di Google .

Enumerazioni
STATE_UNSPECIFIED Stato non specificato.
ACTIVE Il Progetto è attivo.
DELETED Il progetto è stato eliminato temporaneamente.

Metodi

addFirebase

Aggiunge le risorse Firebase al Project Google Cloud Platform (GCP) esistente specificato.

addGoogleAnalytics

Collega il FirebaseProject specificato a un account Google Analytics esistente.

get

Ottiene l' FirebaseProject specificato.

getAdminSdkConfig

Ottiene l'artefatto di configurazione associato all'oggetto FirebaseProject specificato, che può essere utilizzato dai server per semplificare l'inizializzazione.

getAnalyticsDetails

Ottiene i dettagli di Google Analytics attualmente associati all'oggetto FirebaseProject specificato.

list

Elenca ogni FirebaseProject accessibile al chiamante.

patch

Aggiorna gli attributi dell'oggetto FirebaseProject specificato.

removeAnalytics

Scollega il FirebaseProject specificato dal suo account Google Analytics.

searchApps

Elenca tutte le app disponibili per il FirebaseProject specificato.