Pular para o conteúdo principal
Para enviar notificações push a dispositivos Android com o Google Play Services, você precisa de duas coisas do mesmo projeto Firebase:
  1. Uma chave privada de Conta de Serviço do FCM, carregada no OneSignal. Ela autoriza os servidores do OneSignal a enviar para o seu projeto Firebase. Obrigatória.
  2. Um arquivo google-services.json, adicionado ao seu aplicativo. É a configuração de cliente do Firebase que vai dentro do seu aplicativo. Recomendado para todas as novas integrações e obrigatório para o registro com Firebase Installation ID.
Estas instruções não se aplicam a:

Requisitos

  • Um aplicativo Android executado em dispositivos com Google Play Services, incluindo builds do Google Play, instalados manualmente (sideload) e internos
  • Uma conta OneSignal
  • Uma conta Firebase (gratuita)

Criar uma chave privada de Conta de Serviço do Firebase \

1

Criar ou abrir seu Projeto Firebase

Vá para o seu console do Firebase e crie ou selecione um projeto.
Console do Firebase exibindo a lista de projetos disponíveis

Página de Projetos dentro do Firebase

2

Habilitar a API Firebase Cloud Messaging V1

Nas configurações do seu projeto Firebase, selecione a aba Cloud Messaging.
Configurações do projeto Firebase exibindo a aba Cloud Messaging com o status da API Firebase Cloud Messaging (V1) como Enabled

Aba Cloud Messaging nas configurações do projeto Firebase

Verifique o status da Firebase Cloud Messaging API (V1):
  • Enabled (marca de seleção verde) significa que o Google aceita solicitações de envio do Cloud Messaging para este projeto.
  • Disabled significa que o Google rejeita essas solicitações, então as notificações push Android não são entregues. Para habilitar, clique no menu de 3 pontos > Manage API in Google Cloud Console, depois clique em Enable e aguarde até que o status mostre API Enabled com uma marca de seleção verde.
Página da API Firebase Cloud Messaging no Google Cloud Console exibindo o status API Enabled com uma marca de seleção verde

API Firebase Cloud Messaging habilitada no Google Cloud Console

Habilitar a API não concede nenhum papel à Conta de Serviço. Se outra pessoa for proprietária do projeto Firebase ou da conta Google, verifique as permissões da sua Conta de Serviço primeiro.
3

Gerar uma nova chave privada

De volta em Project settings, selecione a aba Service accounts e clique em Generate new private key.
Aba Service accounts nas configurações do projeto Firebase exibindo o botão Generate new private key

Seção de Contas de Serviço dentro do Firebase

Confirme clicando em Generate key no pop-up.
Diálogo de confirmação do Firebase para gerar uma nova chave privada para a Conta de Serviço

Gerar a chave privada para a Conta de Serviço.

A chave privada baixada contém credenciais sensíveis. Não a compartilhe nem a inclua no controle de versão.
Salve o arquivo .json em um local seguro. Você vai carregá-lo no OneSignal na próxima seção.

Carregar a chave privada da Conta de Serviço no OneSignal

Carregue a chave privada para que os servidores do OneSignal possam enviar notificações push pelo seu projeto Firebase.
1

Abrir as configurações de Android

Vá para Settings > Push & In-App e siga as etapas até chegar à configuração do Google Android (FCM).
2

Carregar sua chave privada de Conta de Serviço

Clique em Select file e escolha a chave privada .json que você salvou na seção anterior.
Tela de configuração Google Android (FCM) do OneSignal com o campo de upload do arquivo Service Account JSON e o botão Select file

Tela de configuração FCM

3

Salvar e continuar

Clique em Save & Continue. O OneSignal valida a chave privada e leva você à seleção do SDK.
Se o painel exibir Invalid request, provavelmente falta um papel obrigatório à Conta de Serviço. Veja Como verifico as permissões da minha Conta de Serviço?

Adicionar seu arquivo de configuração do Firebase \

Seu aplicativo precisa de um arquivo google-services.json do mesmo projeto Firebase da Conta de Serviço acima. Não carregue este arquivo no OneSignal. Ele pertence ao código-fonte do seu aplicativo e informa ao aplicativo em qual projeto Firebase se registrar. No SDK Android do OneSignal 5.11.0 e posteriores, o SDK se registra pelo seu projeto Firebase quando o seu google-services.json corresponde ao Sender ID no OneSignal. Caso contrário, o SDK usa o projeto Firebase compartilhado do OneSignal. Veja O que acontece se eu não adicionar o google-services.json?
Atualizando um aplicativo existente? A entrega continua usando o mesmo projeto Firebase e a mesma Conta de Serviço, mas:
  • Cada dispositivo recebe um novo valor de token push na próxima vez que abrir o aplicativo atualizado. Sua Subscription é preservada, e o token antigo funciona até lá.
  • As métricas de FCM do seu console do Firebase passam a incluir os registros do OneSignal.
  • Suas chamadas de token do Firebase agora afetam o OneSignal. Chamar FirebaseMessaging.getInstance().deleteToken() (ao sair da conta, por exemplo) também exclui o registro do OneSignal até que o SDK se registre novamente. Com o registro com Firebase Installation ID, a chamada equivalente é unregister().
Planeje adicionar o arquivo em algum momento. Sem ele, seu aplicativo continua usando tokens de registro FCM legados, que o Firebase descontinuou.
1

Baixar o google-services.json

No seu console do Firebase, abra o projeto que você usou para a chave privada da Conta de Serviço. Vá para Project settings > General e role até Your apps. Se o seu aplicativo Android não estiver listado, clique em Add app.Confirme que o Android package name corresponde ao applicationId do seu aplicativo e depois baixe o google-services.json.
2

Adicioná-lo ao seu aplicativo

Seu aplicativo nunca lê o arquivo em tempo de execução. Uma etapa de build o converte em recursos Android e, sem essa etapa, o arquivo não faz nada. Encontre sua plataforma abaixo e siga o guia de configuração correspondente.
Em versões do SDK anteriores às listadas acima, é seguro adicionar o arquivo, mas ele não tem efeito para o OneSignal. O push continua sendo registrado pelo projeto Firebase compartilhado do OneSignal até você atualizar.
3

Aplicar o plugin Gradle do Google Services

Esta etapa é apenas para Android nativo, React Native e Flutter. As outras plataformas lidam com o plugin conforme descrito na tabela acima.O plugin é resolvido a partir do repositório Maven do Google. Confirme que google() está listado em pluginManagement no settings.gradle ou settings.gradle.kts; caso contrário, o build falha com Plugin [id: 'com.google.gms.google-services'] was not found:
settings.gradle.kts
Adicione o plugin ao seu arquivo Gradle de nível de projeto:
Depois, aplique-o no seu arquivo Gradle de nível de aplicativo:
Se o seu projeto usa um catálogo de versões do Gradle, declare a versão lá em vez de no arquivo de nível de projeto. A etapa de nível de aplicativo acima não muda.
Sincronize o Gradle.O intervalo mantém você no plugin 4.x mais recente. Para fixar uma versão específica, veja a documentação do Google.

Verificar se o arquivo entrou em vigor \

Compile seu aplicativo e confirme que o plugin gerou os recursos de string do Firebase:
Se google_app_id e project_id aparecerem, o arquivo entrou em vigor. Um build bem-sucedido, por si só, não comprova isso.
  • Nenhum dos valores aparece: o plugin não está aplicado. Adicionar o arquivo sem o plugin não gera nenhum erro.
  • File google-services.json is missing: o plugin está aplicado, mas o arquivo não está onde sua cadeia de ferramentas espera. Confira a tabela acima.
  • No matching client found for package name: o pacote registrado no Firebase não corresponde ao seu applicationId. Corrija no console do Firebase e baixe o arquivo novamente.
  • O arquivo vem de um projeto Firebase diferente do da sua Conta de Serviço: veja Fazer corresponder seus projetos Firebase.

Configurar o Firebase sem google-services.json \

Inicialize o FirebaseApp padrão no código se você não puder usar o plugin Gradle do Google Services, ou se carregar o Firebase somente após o consentimento do usuário. Use valores do mesmo projeto Firebase da chave privada da Conta de Serviço que você carregou no OneSignal:
Inicialize o Firebase antes de o OneSignal ser inicializado. Um bucket de armazenamento não é necessário para push. Se a inicialização não tiver terminado quando o OneSignal se registrar para push:
  • No caminho de token legado, o SDK se registra pelo projeto Firebase compartilhado do OneSignal nessa sessão e usa o seu projeto em uma sessão posterior.
  • Com o registro com Firebase Installation ID ativado, o registro falha com o status -32 e é repetido em uma sessão posterior.

Fazer corresponder seus projetos Firebase \

Seu aplicativo deve se registrar no mesmo projeto Firebase da chave privada da Conta de Serviço que você carregou no OneSignal. Quando os projetos são diferentes:
  • No caminho de token legado, o SDK do OneSignal se registra pelo projeto Firebase compartilhado do OneSignal e registra um aviso no log.
  • Com o registro com Firebase Installation ID ativado, o registro falha com o status -6, e as Subscriptions existentes são marcadas como inválidas.
Compare qualquer um dos valores abaixo. O Project ID e o Project Number de um projeto Firebase são pareados permanentemente, então se um corresponder, ambos correspondem. Seu google-services.json tem esta aparência:
google-services.json

Perguntas frequentes

O que acontece se eu não adicionar o google-services.json? \

As notificações push continuam funcionando hoje. O SDK do OneSignal se registra pelo projeto Firebase compartilhado do OneSignal, usando tokens de registro FCM. O Google descontinuou os tokens de registro FCM em favor dos Firebase Installation IDs. O projeto compartilhado não consegue se registrar com Firebase Installation IDs, então adicionar o google-services.json agora prepara seu aplicativo para essa mudança caso o Google passe a exigir Firebase Installation IDs. Sem o arquivo, você também não pode ativar o registro com Firebase Installation ID.

Como verifico as permissões da minha Conta de Serviço? \

Os papéis da Conta de Serviço são concedidos na página IAM do Google Cloud Console, não no console do Firebase nem na página Service Accounts. A Conta de Serviço cuja chave privada você carrega no OneSignal precisa destes dois papéis: Papéis mais amplos como Firebase Admin (roles/firebase.admin), Editor ou Owner também incluem ambas as permissões e satisfazem o requisito. Para Contas de Serviço dedicadas apenas ao OneSignal, prefira o par estreito acima para limitar o impacto se a chave privada for exposta. Se o painel do OneSignal exibir Invalid request após o upload da chave privada da Conta de Serviço, papéis ausentes são a causa mais comum.
1

Abrir a página IAM

No Google Cloud Console, defina o seletor de projetos para o projeto Firebase, não para a organização. Na navegação à esquerda, abra IAM & Admin e clique em IAM.A página é uma tabela com as colunas Principal, Name e Role. Não use Service Accounts > Permissions. Essa página lista quem pode usar a conta, não quais papéis a conta tem no projeto.
2

Encontrar sua Conta de Serviço

Encontre a linha cujo e-mail do principal corresponde ao campo client_email da chave privada que você carregou. Ele tem o formato firebase-adminsdk-xxxxx@YOUR_PROJECT_ID.iam.gserviceaccount.com. Cole esse e-mail na caixa de filtro se a tabela for longa.
3

Adicionar os papéis ausentes

Nessa linha, clique no lápis (Edit principal). No painel Edit permissions, clique em Add another role e adicione Firebase Cloud Messaging API Admin e Firebase Viewer se ainda não estiverem atribuídos. Pule esta etapa se a conta já tiver Firebase Admin, Editor ou Owner.
4

Salvar

Clique em Save. Os novos papéis podem levar cerca de um minuto para entrar em vigor.

Por que estou vendo “This configuration is for a different Firebase Project”?

Este erro ocorre quando a chave privada carregada pertence a um projeto Firebase diferente (um Sender ID diferente). Solução: Use a chave privada do projeto Firebase original. Se não estiver disponível, entre em contato com support@onesignal.com com seu App ID. Trocar projetos redefine os tokens push. Seus usuários devem reabrir o aplicativo para receber push novamente. O inverso também acontece: a chave carregada está correta, mas o aplicativo inclui um google-services.json de um projeto Firebase diferente. Veja Fazer corresponder seus projetos Firebase.

Posso alterar meu Sender ID? \

Sim, mas alterá-lo invalida os tokens de dispositivo existentes, porque os tokens estão vinculados ao Sender ID original. Os usuários deixam de receber notificações push até reabrirem o aplicativo e obterem um novo token. Para obter ajuda, entre em contato com support@onesignal.com com seu App ID.

Por que não vejo um Sender ID no OneSignal? \

Se a sua chave de servidor do Firebase se parece com AIz..., você provavelmente está usando uma configuração desatualizada do Google Cloud Messaging (GCM). Adicione o Firebase ao seu projeto existente do Google Cloud para manter seu Sender ID e depois carregue uma chave privada de Conta de Serviço. Criar um novo projeto Firebase gera um novo Sender ID, o que invalida os tokens push existentes. Veja Posso alterar meu Sender ID?

Preciso atualizar meu código ao mudar para FCM V1?

Nenhuma alteração no aplicativo ou no SDK é necessária. Esta é uma atualização apenas no painel.

As APIs legadas do FCM ainda são suportadas? \

Não. As APIs legadas do FCM do Google foram totalmente descontinuadas e não entregam mais notificações. Se o seu aplicativo ainda as usa, carregue uma chave privada de Conta de Serviço conforme descrito acima para migrar para o FCM V1.

Como posso verificar quais aplicativos ainda usam a API legada?

Chame a API View an app para cada aplicativo e verifique o campo fcm_v1_service_account_json na resposta:
  • Presente e não vazio: o aplicativo está no FCM V1.
  • Ausente ou vazio: o aplicativo não está configurado para FCM V1. Se o aplicativo envia push Android, ainda está na API legada e deve ser migrado.
Para listar primeiro seus aplicativos e seus App IDs, use a API View apps.

O que é Firebase Cloud Messaging e por que o OneSignal precisa de uma chave privada de Conta de Serviço? \

Firebase Cloud Messaging (FCM) é o serviço do Google para entregar notificações push a dispositivos Android. Uma Conta de Serviço é uma identidade do Google que o OneSignal usa para se autenticar no seu projeto Firebase, e sua chave privada é um arquivo JSON que comprova a identidade. Carregar a chave privada autoriza o OneSignal a enviar push pelo Firebase em seu nome. Para mais detalhes, veja a documentação de Conta de Serviço do Google.

Páginas relacionadas

Configuração do SDK Mobile

Instale e inicialize o SDK do OneSignal no seu aplicativo Android.

Registro com Firebase Installation ID

Verifique se o registro com FID está habilitado no seu aplicativo e habilite-o ou desabilite-o.

Configuração de push Huawei

Autorize o OneSignal a enviar push para dispositivos Huawei sem Google Play Services.

Configuração de push Amazon

Gere uma chave de API da Amazon para enviar push a dispositivos Fire OS.

Configuração de push web

Configure notificações push para sites.