REST Resource: projects

Recurso: FirebaseProject

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

Para criar um FirebaseProject, chame projects.addFirebase e especifique um Project do GCP atual. Isso adiciona recursos do Firebase ao Project do GCP.

Como um FirebaseProject também é um Project do GCP, um FirebaseProject tem os mesmos identificadores subjacentes do GCP (projectNumber e projectId). Isso facilita a 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 de recurso do projeto, no formato:

projects/PROJECT_IDENTIFIER

PROJECT_IDENTIFIER: o ProjectNumber (recomendado) do Projeto ou 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.

projectId

string

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

Esse identificador pode aparecer em URLs ou nomes para 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)

Apenas 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 o Firebase ou serviços de terceiros.

displayName

string

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

resources

object (DefaultResources)

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

state

enum (State)

Apenas 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 as anotações no padrão AIP-128 do Google.

Essas anotações são destinadas exclusivamente a desenvolvedores e ferramentas do lado do cliente. Os serviços do Firebase não modificam esse conjunto de anotações.

Um objeto com uma lista de pares "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.

Essa etag é altamente validada.

DefaultResources

Os recursos padrão associados ao projeto.

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

string

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

PROJECT_ID

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

realtimeDatabaseInstance

string

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

PROJECT_ID

Embora seja raro, talvez projectId já esteja sendo usado como o nome de uma instância do Realtime Database em outro projeto. Saiba mais sobre a fragmentação de banco de dados. Nesses casos, projectId é anexado com um hífen e depois cinco caracteres alfanuméricos para criar o nome padrão da instância do Realtime Database. Por exemplo, se projectId for myproject123, o nome padrão da instância do banco de dados poderá ser: myproject123-a5c16

storageBucket

string

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

PROJECT_ID.appspot.com

locationId

string

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

Esse campo será omitido se o local padrão dos recursos do GCP ainda não tiver sido finalizado. Para definir o local padrão dos recursos do GCP em 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 de maneira reversível.

Métodos

addFirebase

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

addGoogleAnalytics

Vincula o FirebaseProject especificado a uma conta do Google Analytics.

get

Recebe o FirebaseProject especificado.

getAdminSdkConfig

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

getAnalyticsDetails

Recebe os detalhes do Google Analytics atualmente associados ao FirebaseProject especificado.

list

Lista cada FirebaseProject acessível ao autor da chamada.

patch

Atualiza os atributos da FirebaseProject especificada.

removeAnalytics

Desvincula o FirebaseProject especificado da conta do Google Analytics dele.

searchApps

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