Instale uma extensão do Firebase

Você pode instalar (e gerenciar ) qualquer uma das extensões oficiais do Firebase usando o console do Firebase ou a CLI do Firebase (interface de linha de comando).

Certifique-se de revisar as diferenças nas ações compatíveis com a Firebase CLI e o Firebase Console.


Para instalar ou gerenciar extensões, você deve receber uma destas funções: Proprietário ou Editor ou Administrador do Firebase .

Para instalar uma extensão, seu projeto deve estar no plano Blaze (pré-pago). Embora não haja cobrança pela instalação de uma extensão, você poderá ser cobrado pelo uso dos serviços do Firebase ou de serviços em nuvem, como o Cloud Secret Manager , se o uso exceder o nível gratuito dos serviços.

Antes de você começar

  1. Se ainda não o fez, adicione o Firebase ao seu projeto .

  2. Se ainda não o fez, atualize seu projeto para o plano Blaze (pré-pago).

  3. Instale ou atualize para a versão mais recente da CLI do Firebase.

  4. Anote o ID do projeto do Firebase ou o alias do projeto configurado anteriormente.

Etapa 1 : visualizar informações detalhadas sobre uma extensão

Esta etapa é opcional, mas altamente recomendada.

Antes de instalar uma extensão do Firebase, recomendamos que você revise informações detalhadas sobre a extensão, incluindo:

  • Como funciona a extensão, quaisquer tarefas de pré-instalação e detalhes sobre a extensão
  • Informações gerais de identificação e descrição
  • Se as tarefas da extensão exigem uma conta de faturamento
  • Serviços do Google (APIs) e funções de acesso necessárias para operação
  • Recursos criados para a extensão (como funções)
  • Descrições de parâmetros configuráveis ​​pelo usuário

Para visualizar as informações detalhadas de uma extensão:

  1. Certifique-se de ter configurado seu ambiente e selecionado uma extensão .

  2. Execute o comando extension-info de qualquer lugar do seu computador:

    firebase ext:info publisher-id/extension-id

    Os argumentos publisher-id e extension-id são obrigatórios e podem ser encontrados na página de detalhes de pré-instalação da extensão .

Etapa 2 : instalar uma extensão

Durante o processo de instalação, você será solicitado a revisar as especificações básicas da extensão (como APIs habilitadas, recursos criados, acesso concedido, etc.). Você será notificado sobre quaisquer requisitos de cobrança e também será solicitado a especificar valores para os parâmetros configuráveis ​​da extensão.

  1. Certifique-se de ter configurado seu ambiente e selecionado uma extensão .

  2. No diretório local do Firebase, execute o comando extension-install. Se solicitado, insira valores de parâmetro para personalizar a instância de extensão.

    firebase ext:install publisher-id/extension-id --project=projectId-or-alias

    Os argumentos publisher-id e extension-id são obrigatórios e podem ser encontrados na página de detalhes de pré-instalação da extensão .

    A execução deste comando adiciona uma instância de extensão ao seu manifesto de extensões .

  3. Em seguida, para implantar as extensões do seu manifesto em um projeto do Firebase, execute:

    firebase deploy --only extensions --project=projectId-or-alias

Etapa 3 : Conclua a configuração pós-instalação

Algumas extensões possuem etapas obrigatórias ou opcionais que você deve concluir antes de usá-las. Encontre essas instruções na página de detalhes pós-instalação da sua extensão no painel Extensões do console do Firebase (o link específico para o painel é exibido no terminal após a instalação).

Você também pode encontrar essas instruções no arquivo POSTINSTALL.md incluído no diretório de origem da extensão .

Crie recursos do Firebase

Se você configurou a extensão para usar recursos do Firebase (coleções do Cloud Firestore, caminhos do Realtime Database, buckets do Cloud Storage) que ainda não existem, crie-os antes de usar a extensão.

Criar manipuladores de eventos Eventarc

Algumas extensões são publicadas no Eventarc quando eventos importantes acontecem durante a execução. Se uma extensão publicar eventos e você tiver habilitado eventos durante a instalação, poderá escrever funções que reajam a esses eventos com sua própria lógica personalizada. Isso pode ser útil, por exemplo, para notificar os usuários quando tarefas de longa execução forem concluídas ou para pós-processar a saída de uma função de extensão.

Consulte a documentação da extensão para obter uma lista de eventos (se houver) que ela publica. Por exemplo, consulte os tipos de eventos para a extensão Executar pagamentos com Stripe .

Em seguida, consulte Gatilhos de eventos personalizados para obter informações sobre como escrever manipuladores de eventos do Eventarc.

Instale várias instâncias de extensão

Você pode instalar a mesma extensão mais de uma vez no mesmo projeto. Cada instância instalada pode ter sua própria configuração customizada e seus próprios recursos de extensão. Você identifica e faz referência a cada instância instalada usando seu ID de instância , que é exclusivo em seu projeto. Você será solicitado a confirmar ou editar o ID da instância de cada instância adicional da extensão instalada.

Próximos passos

  • Veja os detalhes e a configuração da extensão instalada no console do Firebase.

  • Monitore a atividade da extensão instalada, incluindo verificações de integridade, uso e registros.

  • Usando a Firebase CLI, gerencie sua extensão instalada. Você pode reconfigurar ou desinstalar sua extensão, bem como atualizá-la para a versão mais recente.

  • Usando o console do Firebase, gerencie sua extensão instalada. Para extensões oficiais do Firebase, você pode reconfigurar ou desinstalar sua extensão, bem como atualizá-la para a versão mais recente.

  • Como prática recomendada para todos os projetos, configure alertas de orçamento para seu projeto e monitore seu painel de uso e faturamento no Console do Firebase.