REST Resource: projects.webApps

Recurso: WebApp

Detalles de una app de Firebase para la Web.

Representación JSON
{
  "name": string,
  "appId": string,
  "displayName": string,
  "projectId": string,
  "appUrls": [
    string
  ],
  "webId": string,
  "apiKeyId": string,
  "state": enum (State),
  "etag": string
}
Campos
name

string

El nombre del recurso de WebApp, en el formato:

projects/PROJECT_IDENTIFIER/webApps/APP_ID

  • PROJECT_IDENTIFIER: Es el ProjectNumber (recomendado) del proyecto principal o su ProjectId. Obtén más información para usar identificadores de proyectos en el estándar AIP 2510 de Google.
    Ten en cuenta que el valor de PROJECT_IDENTIFIER en cualquier cuerpo de respuesta será el ProjectId.
  • APP_ID: Es el identificador único a nivel global que Firebase le asigna a la app (consulta appId).
appId

string

Solo salida. Inmutable. El identificador único a nivel global asignado por Firebase para el WebApp.

Este identificador debe tratarse como un token opaco, ya que no se especifica el formato de los datos.

displayName

string

El nombre visible asignado por el usuario para WebApp.

projectId

string

Solo salida. Inmutable. Un identificador único asignado por el usuario del elemento superior FirebaseProject para el WebApp.

appUrls[]

string

Las URLs donde se aloja WebApp.

webId
(deprecated)

string

Solo salida. Inmutable. Un identificador único asignado por Firebase para WebApp.

Este identificador solo se usa para propagar el valor de namespace del WebApp. En la mayoría de los casos de uso, usa appId para identificar la app o hacer referencia a esta. El valor webId solo es único dentro de un FirebaseProject y sus apps asociadas.

apiKeyId

string

Es el identificador único a nivel global asignado por Google (UID) para la clave de API de Firebase asociada con WebApp.

Ten en cuenta que este valor es el UID de la clave de API, no el keyString de la clave de API. El keyString es el valor que se puede encontrar en el artefacto de configuración de la app.

Si no se configura apiKeyId en las solicitudes a webApps.Create, Firebase asocia automáticamente un apiKeyId con el WebApp. Esta clave asociada de forma automática puede ser una clave válida existente o, si no existe una clave válida, se aprovisionará una nueva.

En las solicitudes de parches, apiKeyId no se puede establecer en un valor vacío, y el UID nuevo no debe tener restricciones o solo tener restricciones que sean válidas para el WebApp asociado. Recomendamos usar la consola de Google Cloud para administrar las claves de API.

state

enum (State)

Solo salida. El estado del ciclo de vida de la app.

etag

string

El servidor calcula esta suma de comprobación en función del valor de otros campos, y es posible que se envíe con solicitudes de actualización para garantizar que el cliente tenga un valor actualizado antes de continuar.

Obtén más información sobre etag según el estándar AIP-154 de Google.

Esta ETag tiene una validación sólida.

Métodos

create

Solicita la creación de un WebApp nuevo en el FirebaseProject especificado.

get

Obtiene el WebApp especificado.

getConfig

Obtiene el artefacto de configuración asociado con el WebApp especificado.

list

Muestra una lista de cada WebApp asociado con el FirebaseProject especificado.

patch

Actualiza los atributos del WebApp especificado.

remove

Quita el WebApp especificado de FirebaseProject.

undelete

Restablece el WebApp especificado en FirebaseProject.