REST Resource: projects.webApps

Recurso: WebApp

Detalhes de um app do Firebase para a Web.

Representação JSON
{
  "name": string,
  "appId": string,
  "displayName": string,
  "projectId": string,
  "appUrls": [
    string
  ],
  "webId": string,
  "apiKeyId": string,
  "state": enum (State),
  "etag": string
}
Campos
name

string

O nome de recurso do WebApp, no formato:

projects/PROJECT_IDENTIFIER/webApps/APP_ID

  • PROJECT_IDENTIFIER: o ProjectNumber do projeto pai (recomendado) ou o ProjectId dele. Saiba mais sobre o uso de identificadores de projeto no padrão AIP 2510 do Google.
    O valor de PROJECT_IDENTIFIER em qualquer corpo de resposta será ProjectId.
  • APP_ID: o identificador globalmente exclusivo atribuído pelo Firebase para o app (consulte appId).
appId

string

Apenas saída. Imutável. O identificador globalmente exclusivo atribuído pelo Firebase para o WebApp.

Esse identificador precisa ser tratado como um token opaco, porque o formato de dados não é especificado.

displayName

string

O nome de exibição atribuído pelo usuário para WebApp.

projectId

string

Apenas saída. Imutável. Um identificador exclusivo atribuído pelo usuário do FirebaseProject pai do WebApp.

appUrls[]

string

São os URLs em que WebApp está hospedado.

webId
(deprecated)

string

Apenas saída. Imutável. Um identificador exclusivo atribuído pelo Firebase para o WebApp.

Esse identificador é usado apenas para preencher o valor de namespace para o WebApp. Na maioria dos casos de uso, use appId para identificar ou fazer referência ao app. O valor de webId só é exclusivo em um FirebaseProject e nos apps associados a ele.

apiKeyId

string

O identificador globalmente exclusivo atribuído pelo Google (UID, na sigla em inglês) para a chave de API do Firebase associada a WebApp.

Esse valor é o UID da chave de API, não o keyString dela. O keyString é o valor que pode ser encontrado no artefato de configuração do app.

Se apiKeyId não estiver definido nas solicitações para webApps.Create, o Firebase associará automaticamente um apiKeyId ao WebApp. Essa chave associada automaticamente pode ser uma chave válida atual ou, se não existir uma chave válida, uma nova será provisionada.

Em solicitações de patch, apiKeyId não pode ser definido como um valor vazio, e o novo UID não pode ter restrições ou ter restrições válidas apenas para o WebApp associado. Recomendamos usar o Console do Google Cloud para gerenciar as chaves de API.

state

enum (State)

Apenas saída. O estado do ciclo de vida do app.

etag

string

Essa soma de verificação é calculada pelo servidor com base no valor de outros campos e pode ser enviada com solicitações de atualização para garantir que o cliente tenha um valor atualizado antes de prosseguir.

Saiba mais sobre etag no padrão AIP-154 do Google.

Essa etag é altamente validada.

Métodos

create

Solicita a criação de um novo WebApp no FirebaseProject especificado.

get

Recebe o WebApp especificado.

getConfig

Recebe o artefato de configuração associado ao WebApp especificado.

list

Lista cada WebApp associado ao FirebaseProject especificado.

patch

Atualiza os atributos da WebApp especificada.

remove

Remove o WebApp especificado do FirebaseProject.

undelete

Restaura o WebApp especificado para o FirebaseProject.