Para começar a usar o FCM, crie o caso de uso mais simples: enviar uma mensagem de notificação do Editor do Notificações a um dispositivo de desenvolvimento específico quando o app estiver em segundo plano. Esta página descreve todas as etapas para fazer isso, desde a configuração até a verificação. Talvez ela aborde etapas que você já concluiu se tiver configurado um app cliente do Android para o FCM.
Configurar o SDK
Esta seção aborda tarefas que você talvez tenha realizado se já ativou outros elementos do Firebase para seu app.
Antes de começar
Instale ou atualize o Android Studio para a versão mais recente.
Certifique-se de que seu app para Android:
- vise o nível 16 da API (Jelly Bean) ou versões posteriores;
- use o Gradle 4.1 ou versões posteriores.
Configure um dispositivo ou emulador para executar seu app.
- Emuladores precisam usar uma imagem com o Google Play.
Faça login no Firebase usando sua Conta do Google.
Se você ainda não tem um projeto de app Android, faça o download de um dos nossos exemplos de início rápido se quiser conhecer um produto do Firebase.
Criar um projeto do Firebase
Antes de adicionar o Firebase ao seu app para Android, é preciso criar um projeto do Firebase para então conectá-lo ao seu aplicativo. Visite Noções básicas sobre projetos do Firebase para saber mais.
Registrar o app no Firebase
Depois de criar um projeto do Firebase, é possível adicionar seu app para Android a ele.
Consulte Noções básicas sobre projetos do Firebase para ver práticas recomendadas e informações sobre como adicionar apps a um projeto, incluindo como lidar com diversas variantes de versões.
No centro da página de visão geral do projeto do Console do Firebase, clique no ícone do Android para iniciar o fluxo de trabalho de configuração.
Se você já adicionou um aplicativo ao seu projeto do Firebase, clique em Adicionar app para exibir as opções da plataforma.
Insira o ID do aplicativo no campo Nome do pacote do Android.
Às vezes, um ID do aplicativo é chamado de nome do pacote.
Encontre esse ID no módulo (nível do app) do arquivo do Gradle, geralmente
app/build.gradle(ID de exemplo:com.yourcompany.yourproject).
(Opcional) Insira outras informações do app conforme solicitado pelo fluxo de trabalho de configuração.
O apelido é um identificador interno de conveniência e só é visível no Console do Firebase.
Clique em Registrar app.
Adicionar um arquivo de configuração do Firebase
Para adicionar o arquivo de configuração do Firebase para Android ao app, siga estas etapas:
Clique em Fazer o download do google-services.json para receber o arquivo de configuração do Firebase para Android (
google-services.json).- É possível fazer o download do arquivo de configuração do Firebase para Android novamente a qualquer momento.
- Verifique se não há caracteres adicionais no arquivo de configuração, como
(2).
Mova seu arquivo de configuração para o diretório (nível do app) do seu aplicativo.
Para ativar os produtos do Firebase no seu app, adicione o plug-in google-services aos seus arquivos do Gradle.
No nível raiz (nível do projeto) do seu arquivo do Gradle (
build.gradle), adicione as regras para incluir o plug-in do Google Services. Verifique se você tem o repositório Maven do Google também.buildscript { repositories { // Check that you have the following line (if not, add it): google() // Google's Maven repository } dependencies { // ... // Add the following line: classpath 'com.google.gms:google-services:4.3.2' // Google Services plugin } } allprojects { // ... repositories { // Check that you have the following line (if not, add it): google() // Google's Maven repository // ... } }No arquivo do Gradle (geralmente
app/build.gradle) do seu módulo (nível do app), adicione a seguinte linha no fim do arquivo.apply plugin: 'com.android.application' android { // ... } // Add the following line to the bottom of the file: apply plugin: 'com.google.gms.google-services' // Google Play services Gradle plugin
Adicionar SDKs do Firebase ao seu app
É possível adicionar qualquer um dos produtos do Firebase compatíveis ao seu app para Android.
No arquivo Gradle (geralmente
app/build.gradle) do seu módulo (no nível do aplicativo), adicione as dependências dos produtos Firebase que você quer usar no seu aplicativo.Para uma experiência ideal com o Firebase Cloud Messaging, recomendamos ativar o Google Analytics no seu projeto. Como parte da configuração do Google Analytics, é necessário adicionar o SDK do Firebase para o Google Analytics ao seu aplicativo.
Analytics ativado
dependencies { // ...
// Add the Firebase SDK for Google Analytics implementation 'com.google.firebase:firebase-analytics:17.2.1'
// Add the SDK for Firebase Cloud Messaging implementation 'com.google.firebase:firebase-messaging:20.0.0'
// Getting a "Could not find" error? Make sure that you've added // Google's Maven repository to your root-level build.gradle file }Analytics não ativado
dependencies { // ...
// Add the SDK for Firebase Cloud Messaging implementation 'com.google.firebase:firebase-messaging:20.0.0'
// Getting a "Could not find" error? Make sure that you've added // Google's Maven repository to your root-level build.gradle file }Sincronize seu app para garantir que todas as dependências tenham as versões necessárias.
Se você adicionou o Analytics, execute seu app para enviar ao Firebase a confirmação de que você integrou o Firebase com sucesso. Caso contrário, é possível pular a etapa de confirmação.
Os registros do dispositivo exibirão a verificação do Firebase de que a inicialização foi concluída. Se você executou seu app em um emulador com acesso à rede, o Console do Firebase notificará que a conexão do seu app está completa.
Acessar o token de registro
Para enviar uma mensagem a um dispositivo específico, é necessário saber o token de registro dele. Como você precisa informar o token em um campo do console do Notificações para concluir este tutorial, lembre-se de copiar ou armazenar o token em segurança depois de recuperá-lo.
Na primeira inicialização do app, o SDK do FCM gera um token de registro para a instância do app cliente. Se você quiser segmentar dispositivos únicos ou criar grupos, precisará acessar esse token estendendo FirebaseMessagingService e modificando onNewToken.
Veja nesta seção como recuperar o token e monitorar as alterações feitas nele. Como o token pode ser alternado após a primeira inicialização, recomendamos que você recupere o token de registro mais atualizado.
O token de registro pode mudar quando:
- o aplicativo exclui o ID da instância;
- o aplicativo é restaurado em um novo dispositivo;
- o usuário desinstala/reinstala o app;
- o usuário limpa os dados do app.
Recuperar o token de registro atual
Quando você precisar recuperar o token atual, chame FirebaseInstanceId.getInstance().getInstanceId():
Java
FirebaseInstanceId.getInstance().getInstanceId()
.addOnCompleteListener(new OnCompleteListener<InstanceIdResult>() {
@Override
public void onComplete(@NonNull Task<InstanceIdResult> task) {
if (!task.isSuccessful()) {
Log.w(TAG, "getInstanceId failed", task.getException());
return;
}
// Get new Instance ID token
String token = task.getResult().getToken();
// Log and toast
String msg = getString(R.string.msg_token_fmt, token);
Log.d(TAG, msg);
Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show();
}
});
Kotlin
FirebaseInstanceId.getInstance().instanceId
.addOnCompleteListener(OnCompleteListener { task ->
if (!task.isSuccessful) {
Log.w(TAG, "getInstanceId failed", task.exception)
return@OnCompleteListener
}
// Get new Instance ID token
val token = task.result?.token
// Log and toast
val msg = getString(R.string.msg_token_fmt, token)
Log.d(TAG, msg)
Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show()
})
Monitorar a geração de tokens
O retorno de chamada onNewToken é acionado sempre que um novo token é gerado.
Java
/**
* Called if InstanceID token is updated. This may occur if the security of
* the previous token had been compromised. Note that this is called when the InstanceID token
* is initially generated so this is where you would retrieve the token.
*/
@Override
public void onNewToken(String token) {
Log.d(TAG, "Refreshed token: " + token);
// If you want to send messages to this application instance or
// manage this apps subscriptions on the server side, send the
// Instance ID token to your app server.
sendRegistrationToServer(token);
}
Kotlin
/**
* Called if InstanceID token is updated. This may occur if the security of
* the previous token had been compromised. Note that this is called when the InstanceID token
* is initially generated so this is where you would retrieve the token.
*/
override fun onNewToken(token: String) {
Log.d(TAG, "Refreshed token: $token")
// If you want to send messages to this application instance or
// manage this apps subscriptions on the server side, send the
// Instance ID token to your app server.
sendRegistrationToServer(token)
}
Quando receber o token, você poderá enviá-lo ao servidor do app e armazená-lo usando o método de sua preferência. Consulte a referência da API Instance ID para ver os detalhes da API.
Enviar uma mensagem de notificação de teste
Instale e execute o app no dispositivo de destino.
Verifique se o app está em segundo plano no dispositivo.
Abra o Editor do Notificações e selecione Nova notificação.
Digite o texto da mensagem.
Selecione Enviar mensagem de teste.
No campo Adicionar um token de registro do FCM, insira o token de registro obtido na seção anterior deste guia.
Clique em Testar.
Depois de clicar em Testar, o dispositivo cliente com o app em segundo plano receberá a notificação na bandeja de notificações do sistema.
Para ver insights sobre a entrega de mensagens ao seu aplicativo, consulte o painel de relatórios do FCM, que registra o número de mensagens enviadas e abertas em dispositivos iOS e Android, além de dados de "impressões" (notificações vistas pelos usuários) de apps para Android.
Próximas etapas
Enviar mensagens aos apps em primeiro plano
Depois de enviar com êxito mensagens de notificação enquanto o app está em segundo plano, consulte Receber mensagens em um app para Android para começar a enviar a apps em primeiro plano.
Vá além das mensagens de notificação
Para ir além das notificações e adicionar outros comportamentos mais avançados ao seu app, consulte os seguintes artigos: