REST Resource: projects

Ressource: FirebaseProject

Ein FirebaseProject ist die Firebase-Entität der obersten Ebene. Es ist der Container für Firebase-Apps, Firebase-Hosting-Sites, Speichersysteme (Firebase Realtime Database, Cloud Firestore, Cloud Storage Buckets) und andere Firebase- und Google Cloud Platform (GCP)-Ressourcen.

Sie erstellen ein FirebaseProject , indem Sie projects.addFirebase aufrufen und ein vorhandenes GCP- Project angeben. Dadurch werden Firebase-Ressourcen zum vorhandenen GCP- Project hinzugefügt.

Da ein FirebaseProject tatsächlich auch ein GCP- Project ist, verfügt ein FirebaseProject über dieselben zugrunde liegenden GCP-Kennungen ( projectNumber und projectId ). Dies ermöglicht eine einfache Interaktion mit Google APIs.

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

string

Der Ressourcenname des Projekts im Format:

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER : die ProjectNumber des Projekts (empfohlen) oder seine ProjectId .
Erfahren Sie mehr über die Verwendung von Projektkennungen im AIP 2510-Standard von Google.
Beachten Sie, dass der Wert für PROJECT_IDENTIFIER in jedem Antworttext die ProjectId ist.

projectId

string

Nur Ausgabe. Unveränderlich. Eine vom Benutzer zugewiesene eindeutige Kennung für das Projekt.

Dieser Bezeichner kann in URLs oder Namen für einige mit dem Projekt verknüpfte Firebase-Ressourcen erscheinen, sollte aber im Allgemeinen als praktischer Alias ​​zur Referenzierung des Projekts behandelt werden.

projectNumber

string ( int64 format)

Nur Ausgabe. Unveränderlich. Die weltweit eindeutige, von Google zugewiesene kanonische Kennung für das Projekt. Verwenden Sie diese Kennung, wenn Sie Integrationen konfigurieren und/oder API-Aufrufe an Firebase oder Dienste von Drittanbietern durchführen.

displayName

string

Der vom Benutzer zugewiesene Anzeigename des Projekts.

resources

object ( DefaultResources )

Nur Ausgabe. Die standardmäßigen Firebase-Ressourcen, die dem Projekt zugeordnet sind.

state

enum ( State )

Nur Ausgabe. Der Lebenszyklusstatus des Projekts.

annotations

map (key: string, value: string)

Eine Reihe benutzerdefinierter Anmerkungen für das FirebaseProject .
Erfahren Sie mehr über Anmerkungen im AIP-128-Standard von Google.

Diese Anmerkungen sind ausschließlich für Entwickler und clientseitige Tools bestimmt. Firebase-Dienste verändern diesen Annotationssatz nicht.

Ein Objekt, das eine Liste von "key": value Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

etag

string

Diese Prüfsumme wird vom Server basierend auf dem Wert anderer Felder berechnet und kann mit Aktualisierungsanfragen gesendet werden, um sicherzustellen, dass der Client über einen aktuellen Wert verfügt, bevor er fortfährt.

Erfahren Sie mehr über etag im AIP-154-Standard von Google.

Dieses Etag ist stark validiert.

Standardressourcen

Die mit dem Projekt verknüpften Standardressourcen.

JSON-Darstellung
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
Felder
hostingSite

string

Nur Ausgabe. Der Standardname der Firebase Hosting-Site im Format:

PROJECT_ID

Obwohl selten, wird Ihre projectId möglicherweise bereits als Name für eine vorhandene Hosting-Site in einem anderen Projekt verwendet (weitere Informationen zum Erstellen nicht standardmäßiger, zusätzlicher Sites ). In diesen Fällen wird an Ihre projectId ein Bindestrich und dann fünf alphanumerische Zeichen angehängt, um Ihren Standardnamen für die Hosting-Site zu erstellen. Wenn Ihre projectId beispielsweise „ myproject123 lautet, könnte der Name Ihrer Standard-Hosting-Site lauten: myproject123-a5c16

realtimeDatabaseInstance

string

Nur Ausgabe. Der Standardname der Firebase Realtime Database-Instanz im Format:

PROJECT_ID

Obwohl selten, wird Ihre projectId möglicherweise bereits als Name für eine vorhandene Echtzeitdatenbankinstanz in einem anderen Projekt verwendet (weitere Informationen zum Datenbank-Sharding ). In diesen Fällen wird an Ihre projectId ein Bindestrich und dann fünf alphanumerische Zeichen angehängt, um Ihren Standardnamen für die Echtzeitdatenbankinstanz zu erstellen. Wenn Ihre projectId beispielsweise „ myproject123 lautet, könnte Ihr Standardname für die Datenbankinstanz lauten: myproject123-a5c16

storageBucket

string

Nur Ausgabe. Der standardmäßige Cloud Storage für Firebase-Speicher-Bucket im Format:

PROJECT_ID .appspot.com

locationId

string

Nur Ausgabe. Die ID des standardmäßigen GCP-Ressourcenstandorts des Projekts. Der Standort ist einer der verfügbaren GCP-Ressourcenstandorte .

Dieses Feld wird weggelassen, wenn der standardmäßige GCP-Ressourcenstandort noch nicht festgelegt wurde. Um den standardmäßigen GCP-Ressourcenspeicherort eines Projekts festzulegen, rufen Sie defaultLocation.finalize auf, nachdem Sie Firebase-Ressourcen zum Projekt hinzugefügt haben.

Zustand

Die möglichen Lebenszykluszustände des Projekts. Erfahren Sie mehr über Zustände im AIP-216-Standard von Google.

Aufzählungen
STATE_UNSPECIFIED Nicht spezifizierter Zustand.
ACTIVE Das Projekt ist aktiv.
DELETED Das Projekt wurde vorläufig gelöscht.

Methoden

addFirebase

Fügt Firebase-Ressourcen zum angegebenen vorhandenen Google Cloud Platform (GCP) Project hinzu.

addGoogleAnalytics

Verknüpft das angegebene FirebaseProject mit einem vorhandenen Google Analytics-Konto .

get

Ruft das angegebene FirebaseProject ab.

getAdminSdkConfig

Ruft das dem angegebenen FirebaseProject zugeordnete Konfigurationsartefakt ab, das von Servern zur Vereinfachung der Initialisierung verwendet werden kann.

getAnalyticsDetails

Ruft die Google Analytics-Details ab, die derzeit dem angegebenen FirebaseProject zugeordnet sind.

list

Listet jedes FirebaseProject auf, auf das der Aufrufer zugreifen kann.

patch

Aktualisiert die Attribute des angegebenen FirebaseProject .

removeAnalytics

Hebt die Verknüpfung des angegebenen FirebaseProject mit seinem Google Analytics-Konto auf.

searchApps

Listet alle verfügbaren Apps für das angegebene FirebaseProject auf.