REST Resource: projects

Recurso: FirebaseProject

Um FirebaseProject é a entidade Firebase de nível superior. É o contêiner para Firebase Apps, sites Firebase Hosting, sistemas de armazenamento (Firebase Realtime Database, Cloud Firestore, baldes Cloud Storage) e outros recursos Firebase e Google Cloud Platform (GCP).

Você cria um FirebaseProject chamando projects.addFirebase e especificando um Project GCP existente . Isso adiciona recursos do Firebase ao Project GCP existente.

Como um FirebaseProject também é um GCP Project , um FirebaseProject tem os mesmos identificadores subjacentes do GCP ( projectNumber e projectId ). Isso permite uma fácil interoperabilidade com as APIs do Google.

representação JSON
{
  "name": string,
  "projectId": string,
  "projectNumber": string,
  "displayName": string,
  "resources": {
    object (DefaultResources)
  },
  "state": enum (State),
  "annotations": {
    string: string,
    ...
  },
  "etag": string
}
Campos
name

string

O nome do recurso do Projeto, no formato:

projects/ PROJECT_IDENTIFIER

PROJECT_IDENTIFIER : o ProjectNumber do Projeto (recomendado) ou seu ProjectId .
Saiba mais sobre como usar identificadores de projeto no padrão AIP 2510 do Google.
Observe que o valor de PROJECT_IDENTIFIER em qualquer corpo de resposta será o ProjectId .

projectId

string

Somente saída. Imutável. Um identificador exclusivo atribuído pelo usuário para o projeto.

Esse identificador pode aparecer em URLs ou nomes de alguns recursos do Firebase associados ao projeto, mas geralmente deve ser tratado como um alias de conveniência para fazer referência ao projeto.

projectNumber

string ( int64 format)

Somente saída. Imutável. O identificador canônico globalmente exclusivo atribuído pelo Google para o projeto. Use esse identificador ao configurar integrações e/ou fazer chamadas de API para Firebase ou serviços de terceiros.

displayName

string

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

resources

object ( DefaultResources )

Somente saída. Os recursos padrão do Firebase associados ao projeto.

state

enum ( State )

Somente saída. O estado do ciclo de vida do Projeto.

annotations

map (key: string, value: string)

Um conjunto de anotações definidas pelo usuário para o FirebaseProject .
Saiba mais sobre anotações no padrão AIP-128 do Google.

Essas anotações destinam-se exclusivamente a desenvolvedores e ferramentas do lado do cliente. Os serviços do Firebase não modificarão este conjunto de anotações.

Um objeto contendo uma lista de "key": value . Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" } .

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.

Este etag é fortemente validado.

Recursos padrão

Os recursos padrão associados ao Projeto.

representação JSON
{
  "hostingSite": string,
  "realtimeDatabaseInstance": string,
  "storageBucket": string,
  "locationId": string
}
Campos
hostingSite

string

Somente saída. O nome do site padrão do Firebase Hosting, no formato:

PROJECT_ID

Embora raro, seu projectId já pode ser usado como o nome de um site de hospedagem existente em outro projeto (saiba mais sobre como criar sites adicionais não padrão). Nesses casos, seu projectId é anexado com um hífen e cinco caracteres alfanuméricos para criar seu nome de site padrão do Hosting. Por exemplo, se seu projectId for myproject123 , o nome do site de hospedagem padrão pode ser: myproject123-a5c16

realtimeDatabaseInstance

string

Somente saída. O nome da instância padrão do Firebase Realtime Database, no formato:

PROJECT_ID

Embora raro, seu projectId já pode ser usado como o nome de uma instância existente do Realtime Database em outro projeto (saiba mais sobre fragmentação de banco de dados). Nesses casos, seu projectId é anexado com um hífen e cinco caracteres alfanuméricos para criar seu nome de instância padrão do Realtime Database. Por exemplo, se seu projectId for myproject123 , seu nome de instância de banco de dados padrão pode ser: myproject123-a5c16

storageBucket

string

Somente saída. O intervalo de armazenamento padrão do Cloud Storage para Firebase, no formato:

PROJECT_ID .appspot.com

locationId

string

Somente saída. O código do local padrão do recurso GCP do projeto. O local é um dos locais de recursos GCP disponíveis.

Este campo será omitido se o local padrão do recurso GCP ainda não tiver sido finalizado. Para definir o local padrão do recurso GCP de um projeto, chame defaultLocation.finalize depois de adicionar recursos do Firebase ao projeto.

Estado

Os possíveis estados do ciclo de vida do projeto. Saiba mais sobre os estados no padrão AIP-216 do Google.

Enums
STATE_UNSPECIFIED Estado não especificado.
ACTIVE O Projeto está ativo.
DELETED O projeto foi excluído temporariamente.

Métodos

addFirebase

Adiciona recursos do Firebase ao Project existente do Google Cloud Platform (GCP) especificado.

addGoogleAnalytics

Vincula o FirebaseProject especificado a uma conta existente do Google Analytics .

get

Obtém o FirebaseProject especificado.

getAdminSdkConfig

Obtém o artefato de configuração associado ao FirebaseProject especificado, que pode ser usado por servidores para simplificar a inicialização.

getAnalyticsDetails

Obtém os detalhes do Google Analytics atualmente associados ao FirebaseProject especificado.

list

Lista cada FirebaseProject acessível ao chamador.

patch

Atualiza os atributos do FirebaseProject especificado.

removeAnalytics

Desvincula o FirebaseProject especificado de sua conta do Google Analytics.

searchApps

Lista todos os aplicativos disponíveis para o FirebaseProject especificado.