REST Resource: projects.webApps

Ressource : WebApp

Détails d'une application Firebase pour le Web.

Représentation JSON
{
  "name": string,
  "appId": string,
  "displayName": string,
  "projectId": string,
  "appUrls": [
    string
  ],
  "webId": string,
  "apiKeyId": string,
  "state": enum (State),
  "etag": string
}
Des champs
name

string

Le nom de la ressource de la WebApp , au format :

projects/ PROJECT_IDENTIFIER /webApps/ APP_ID

  • PROJECT_IDENTIFIER : le ProjectNumber du projet parent (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 .
  • APP_ID : l'identifiant unique au monde attribué par Firebase pour l'application (voir appId ).
appId

string

Sortie uniquement. Immuable. Identifiant unique au monde, attribué par Firebase pour la WebApp .

Cet identifiant doit être traité comme un jeton opaque, car le format des données n'est pas spécifié.

displayName

string

Nom d'affichage attribué par l'utilisateur pour la WebApp .

projectId

string

Sortie uniquement. Immuable. Un identifiant unique attribué par l'utilisateur du FirebaseProject parent pour la WebApp .

appUrls[]

string

Les URL où la WebApp est hébergée.

webId
(deprecated)

string

Sortie uniquement. Immuable. Un identifiant unique attribué par Firebase pour la WebApp .

Cet identifiant est uniquement utilisé pour renseigner la valeur namespace de la WebApp . Pour la plupart des cas d'utilisation, utilisez appId pour identifier ou référencer l'application. La valeur webId est unique uniquement au sein d'un FirebaseProject et de ses applications associées.

apiKeyId

string

L'identifiant (UID) attribué par Google, unique au monde, pour la clé API Firebase associée à la WebApp .

Sachez que cette valeur est l'UID de la clé API, et non la keyString de la clé API. Le keyString est la valeur qui peut être trouvée dans l' artefact de configuration de l'application.

Si apiKeyId n'est pas défini dans les requêtes adressées à webApps.Create , Firebase associe automatiquement un apiKeyId à WebApp . Cette clé auto-associée peut être une clé valide existante ou, si aucune clé valide n'existe, une nouvelle sera fournie.

Dans les demandes de correctifs, apiKeyId ne peut pas être défini sur une valeur vide et le nouvel UID ne doit avoir aucune restriction ou uniquement des restrictions valides pour la WebApp associée. Nous vous recommandons d'utiliser Google Cloud Console pour gérer les clés API.

state

enum ( State )

Sortie uniquement. L'état du cycle de vie de l'application.

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.

Méthodes

create

Demande la création d'une nouvelle WebApp dans le FirebaseProject spécifié.

get

Obtient la WebApp spécifiée.

getConfig

Obtient l'artefact de configuration associé à la WebApp spécifiée.

list

Répertorie chaque WebApp associée au FirebaseProject spécifié.

patch

Met à jour les attributs de la WebApp spécifiée.

remove

Supprime la WebApp spécifiée du FirebaseProject .

undelete

Restaure la WebApp spécifiée dans le FirebaseProject .