REST Resource: projects.webApps

Ressource: WebApp

Details einer Firebase-App für das Web.

JSON-Darstellung
{
  "name": string,
  "appId": string,
  "displayName": string,
  "projectId": string,
  "appUrls": [
    string
  ],
  "webId": string,
  "apiKeyId": string,
  "state": enum (State),
  "etag": string
}
Felder
name

string

Der Ressourcenname der WebApp im Format:

projects/ PROJECT_IDENTIFIER /webApps/ APP_ID

  • PROJECT_IDENTIFIER : die ProjectNumber des übergeordneten 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.
  • APP_ID : die weltweit eindeutige, von Firebase zugewiesene Kennung für die App (siehe appId ).
appId

string

Nur Ausgabe. Unveränderlich. Der weltweit eindeutige, von Firebase zugewiesene Bezeichner für die WebApp .

Dieser Bezeichner sollte als undurchsichtiges Token behandelt werden, da das Datenformat nicht angegeben ist.

displayName

string

Der vom Benutzer zugewiesene Anzeigename für die WebApp .

projectId

string

Nur Ausgabe. Unveränderlich. Eine vom Benutzer zugewiesene eindeutige Kennung des übergeordneten FirebaseProject für die WebApp .

appUrls[]

string

Die URLs, unter denen die WebApp gehostet wird.

webId
(deprecated)

string

Nur Ausgabe. Unveränderlich. Eine eindeutige, von Firebase zugewiesene Kennung für die WebApp .

Dieser Bezeichner wird nur zum Auffüllen des namespace Werts für die WebApp verwendet. In den meisten Anwendungsfällen verwenden Sie appId , um die App zu identifizieren oder zu referenzieren. Der webId Wert ist nur innerhalb eines FirebaseProject und der zugehörigen Apps eindeutig.

apiKeyId

string

Die weltweit eindeutige, von Google zugewiesene Kennung (UID) für den Firebase-API-Schlüssel, der mit der WebApp verknüpft ist.

Beachten Sie, dass es sich bei diesem Wert um die UID des API-Schlüssels und nicht um den keyString des API-Schlüssels handelt. Der keyString ist der Wert, der im Konfigurationsartefakt der App zu finden ist.

Wenn apiKeyId in Anfragen an webApps.Create nicht festgelegt ist, ordnet Firebase der WebApp automatisch eine apiKeyId zu. Bei diesem automatisch zugeordneten Schlüssel kann es sich um einen vorhandenen gültigen Schlüssel handeln. Wenn kein gültiger Schlüssel vorhanden ist, wird ein neuer bereitgestellt.

In Patch-Anfragen kann apiKeyId nicht auf einen leeren Wert gesetzt werden und die neue UID darf keine oder nur Einschränkungen haben, die für die zugehörige WebApp gültig sind. Wir empfehlen die Verwendung der Google Cloud Console zur Verwaltung von API-Schlüsseln.

state

enum ( State )

Nur Ausgabe. Der Lebenszyklusstatus der App.

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.

Methoden

create

 Fordert die Erstellung einer neuen WebApp im angegebenen FirebaseProject an.

get

 Ruft die angegebene WebApp ab.

getConfig

 Ruft das Konfigurationsartefakt ab, das der angegebenen WebApp zugeordnet ist.

list

 Listet jede WebApp auf, die dem angegebenen FirebaseProject zugeordnet ist.

patch

 Aktualisiert die Attribute der angegebenen WebApp .

remove

 Entfernt die angegebene WebApp aus dem FirebaseProject .

undelete

 Stellt die angegebene WebApp im FirebaseProject wieder her.