- 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.
- 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.
- Web Push. Dispositivos Android podem se inscrever no seu site ou PWA sem uma Conta de Serviço do FCM. Veja Configuração de push web.
- Dispositivos Huawei sem Google Play Services. Veja Autorização Huawei.
- Dispositivos Amazon (Fire OS). Veja Geração de chave de API da Amazon.
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 \
Criar ou abrir seu Projeto Firebase

Página de Projetos dentro do Firebase
Habilitar a API Firebase Cloud Messaging V1

Aba Cloud Messaging nas configurações do projeto Firebase
- 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.

API Firebase Cloud Messaging habilitada no Google Cloud Console
Gerar uma nova chave privada

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

Gerar a chave privada para a Conta de Serviço.
.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.Abrir as configurações de Android
Carregar sua chave privada de Conta de Serviço
.json que você salvou na seção anterior.
Tela de configuração FCM
Salvar e continuar
Adicionar seu arquivo de configuração do Firebase \
Seu aplicativo precisa de um arquivogoogle-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?
Baixar o google-services.json
applicationId do seu aplicativo e depois baixe o google-services.json.Adicioná-lo ao seu aplicativo
Aplicar o plugin Gradle do Google Services
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:Verificar se o arquivo entrou em vigor \
Compile seu aplicativo e confirme que o plugin gerou os recursos de string do Firebase: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 seuapplicationId. 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 oFirebaseApp 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:
- 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
-32e é 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.
google-services.json tem esta aparência:
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 ogoogle-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: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.
Abrir a página IAM
Encontrar sua Conta de Serviço
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.Adicionar os papéis ausentes
Salvar
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 comsupport@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 comsupport@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 comAIz..., 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 campofcm_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.