É possível instalar (e gerenciar) qualquer uma das extensões oficiais do Firebase usando o console Firebase, a CLI do Firebase (interface de linha de comando) ou um SDK gerado automaticamente.
Analise as diferenças nas ações compatíveis com cada método de instalação.
Para instalar ou gerenciar extensões, é necessário atribuir um destes papéis: Proprietário ou Editor ou Administrador do Firebase.
Para instalar uma extensão, o projeto precisa estar no plano Blaze (pagamento por utilização). A instalação de uma extensão é feita sem custos financeiros, mas você poderá receber cobranças pelo uso de serviços do Firebase ou do Cloud, como o Cloud Secret Manager, se o uso exceder o Nível sem custos financeiros dos serviços.
Antes de começar
Adicione o Firebase ao projeto e faça upgrade dele para o plano Blaze (pagamento por utilização) se ainda não tiver feito isso.
Etapa 1: visualizar informações detalhadas sobre uma extensão
Esta etapa é opcional, mas altamente recomendada.
Antes de instalar um Firebase Extension, recomendamos que você leia informações detalhadas sobre a extensão, incluindo:
- Como a extensão funciona, as tarefas de pré-instalação e os detalhes sobre ela
- 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 papéis de acesso necessários 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:
Procure extensões oficiais do Firebase no Extensions Hub.
Clique no cartão de uma extensão para:
exibir as informações detalhadas da extensão;
Encontre o link para o código-fonte da extensão no Repositório de origem Firebase Extensions.
No diretório de extensões da extensão, essas informações detalhadas podem ser visualizadas no
README.
Etapa 2: instalar uma extensão
Durante o processo de instalação, será solicitado que você analise as especificações básicas da extensão (como APIs ativadas, recursos criados, acesso concedido, etc.). Você será notificado sobre os requisitos de faturamento e solicitado a especificar valores para os parâmetros configuráveis da extensão.
Procure extensões oficiais do Firebase no Extensions Hub.
Clique no cartão de uma extensão e analise as informações detalhadas dela, que podem oferecer instruções de uso específicas e tarefas de pré-instalação.
Clique em Instalar e siga as instruções na tela para instalar a extensão.
Etapa 3: concluir a configuração pós-instalação
Algumas extensões têm etapas obrigatórias ou opcionais para você concluir antes de usá-las. Encontre essas instruções na página de detalhes de pós-instalação da extensão no painel "Extensions" do Console do Firebase (o link específico para o painel é exibido no terminal após a instalação).
Essas instruções também podem ser encontradas no arquivo POSTINSTALL.md
incluído no
diretório de origem da extensão.
Criar recursos do Firebase
Se você configurou a extensão para usar recursos do Firebase (coleções do Cloud Firestore, caminhos do Realtime Database e buckets do Cloud Storage) que ainda não existem, crie-os antes de usar a extensão.
Criar manipuladores de eventos do 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 ativado eventos durante a instalação, será possível escrever funções que reagem 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 duração forem concluídas ou para pós-processar a saída de uma função de extensão.
Acesse a documentação da extensão para consultar uma lista dos eventos publicados (se houver). Por exemplo, consulte os tipos de evento para a extensão Fazer pagamentos com a Stripe.
Em seguida, consulte Acionadores de evento personalizados para informações sobre como criar manipuladores de eventos do Eventarc.
Instalar várias instâncias de extensões
É possível instalar a mesma extensão mais de uma vez no mesmo projeto. Cada instância instalada pode ter sua própria configuração personalizada e recursos de extensão. Identifique e faça referência a cada instância instalada usando o ID da instância exclusivo do projeto.
Você precisará confirmar ou editar o ID de cada instância adicional da extensão que instalar.
Próximas etapas
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 o Console do Firebase, gerencie sua extensão instalada. Para extensões oficiais do Firebase, é possível reconfigurar ou desinstalar sua extensão, além de 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 o Painel de uso e faturamento no Console do Firebase.