Per scegliere come target di un messaggio più dispositivi, utilizza Messaggistica argomento. Questa funzionalità ti consente di inviare un messaggio a più dispositivi che hanno attivato un determinato argomento.
Questo tutorial si concentra sull'invio di messaggi di argomento dal server dell'app utilizzando Admin SDK o l'API REST per FCM, nonché sulla loro ricezione e gestione in un'app per Android. Tratteremo la gestione dei messaggi sia per le app in primo piano sia per quelle in background. Sono coperti tutti i passaggi per raggiungere questo obiettivo, dalla configurazione alla verifica.
Configura l'SDK
Questa sezione potrebbe includere passaggi che hai già completato se hai configurato un'app client per Android per FCM o hai seguito i passaggi per inviare il tuo primo messaggio.
Prima di iniziare
Installa o aggiorna Android Studio alla versione più recente.
Assicurati che il tuo progetto soddisfi questi requisiti (tieni presente che alcuni prodotti potrebbero avere requisiti più stringenti):
- Ha il livello API target 21 (Lollipop) o versioni successive
- Android 5.0 o versioni successive
- Utilizza
Jetpack (AndroidX),
che include il rispetto di questi requisiti di versione:
com.android.tools.build:gradle
v7.3.0 o successivecompileSdkVersion
28 o versioni successive
Configura un dispositivo fisico o utilizza un emulatore per eseguire l'app.
Tieni presente che gli SDK Firebase con una dipendenza dai servizi Google Play richiedono l'installazione di Google Play Services sul dispositivo o sull'emulatore.Accedi a Firebase con il tuo Account Google.
Se non disponi già di un progetto Android e vuoi semplicemente provare un prodotto Firebase, puoi scaricare uno dei nostri esempi di guide rapide.
Crea un progetto Firebase
Prima di poter aggiungere Firebase alla tua app per Android, devi creare un progetto Firebase per connetterti all'app. Per saperne di più sui progetti Firebase, consulta Informazioni sui progetti Firebase.
Registra la tua app con Firebase
Per utilizzare Firebase nella tua app per Android, devi registrare l'app con il tuo progetto Firebase. La registrazione dell'app è spesso chiamata "aggiunta" dell'app al progetto.
Vai alla console Firebase.
Al centro della pagina di riepilogo del progetto, fai clic sull'icona Android (
) o su Aggiungi app per avviare il flusso di lavoro di configurazione.Inserisci il nome del pacchetto dell'app nel campo Nome pacchetto Android.
(Facoltativo) Inserisci altre informazioni sull'app: Nickname dell'app e Certificato SHA-1 per la firma di debug.
Fai clic su Registra app.
Aggiungi un file di configurazione di Firebase
Scarica e aggiungi il file di configurazione di Firebase per Android (
) alla tua app:google-services.json Fai clic su Scarica google-services.json per ottenere il file di configurazione di Firebase per Android.
Sposta il file di configurazione nella directory principale del modulo (a livello di app) della tua app.
Per rendere accessibili ai valori nel file di configurazione
gli SDK Firebase, è necessario il plug-in Gradle dei servizi Google (google-services.json google-services
).Nel file Gradle a livello di directory principale (a livello di progetto) (
<project>/build.gradle.kts
o<project>/build.gradle
), aggiungi il plug-in dei servizi Google come dipendenza:Kotlin
plugins { id("com.android.application") version "7.3.0" apply false // ... // Add the dependency for the Google services Gradle plugin id("com.google.gms.google-services") version "4.4.2" apply false }
Groovy
plugins { id 'com.android.application' version '7.3.0' apply false // ... // Add the dependency for the Google services Gradle plugin id 'com.google.gms.google-services' version '4.4.2' apply false }
Nel file Gradle del modulo (a livello di app) (di solito
<project>/<app-module>/build.gradle.kts
o<project>/<app-module>/build.gradle
), aggiungi il plug-in dei servizi Google:Kotlin
plugins { id("com.android.application") // Add the Google services Gradle plugin id("com.google.gms.google-services") // ... }
Groovy
plugins { id 'com.android.application' // Add the Google services Gradle plugin id 'com.google.gms.google-services' // ... }
Aggiungere gli SDK Firebase all'app
Nel file Gradle del modulo (a livello di app) (di solito
<project>/<app-module>/build.gradle.kts
o<project>/<app-module>/build.gradle
), aggiungi la dipendenza per la libreria Firebase Cloud Messaging per Android. Ti consigliamo di utilizzare Firebase Android BoM per controllare la versione della libreria.Per un'esperienza ottimale con Firebase Cloud Messaging, ti consigliamo di attivare Google Analytics nel tuo progetto Firebase e di aggiungere l'SDK Firebase per Google Analytics alla tua app.
dependencies { // Import the BoM for the Firebase platform implementation(platform("com.google.firebase:firebase-bom:33.6.0")) // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When using the BoM, you don't specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging") implementation("com.google.firebase:firebase-analytics") }
Se utilizzi Firebase Android BoM, la tua app utilizzerà sempre versioni compatibili delle librerie Firebase Android.
(Alternativa) Aggiungi le dipendenze della libreria Firebase senza utilizzare il file BoM
Se scegli di non utilizzare Firebase BoM, devi specificare ogni versione della libreria Firebase nella relativa riga di dipendenza.
Tieni presente che se nella tua app utilizzi più librerie Firebase, ti consigliamo vivamente di utilizzare BoM per gestire le versioni della libreria, in modo che tutte le versioni siano compatibili.
dependencies { // Add the dependencies for the Firebase Cloud Messaging and Analytics libraries // When NOT using the BoM, you must specify versions in Firebase library dependencies implementation("com.google.firebase:firebase-messaging:24.1.0") implementation("com.google.firebase:firebase-analytics:22.1.2") }
Sincronizza il tuo progetto Android con i file Gradle.
Sottoscrivere l'abbonamento dell'app client a un argomento
Le app client possono iscriversi a qualsiasi argomento esistente o possono crearne uno nuovo. Quando un'app client si iscrive a un nuovo nome di argomento (che non esiste già per il tuo progetto Firebase), in FCM viene creato un nuovo argomento con quel nome e qualsiasi client può successivamente iscriversi.
Per abbonarsi a un argomento, l'app client chiama Firebase Cloud Messaging
subscribeToTopic()
con il nome dell'argomento FCM. Questo metodo
restituisce un Task
, che può essere utilizzato da un listener di completamento per determinare se
l'abbonamento è andato a buon fine:
Kotlin+KTX
Firebase.messaging.subscribeToTopic("weather") .addOnCompleteListener { task -> var msg = "Subscribed" if (!task.isSuccessful) { msg = "Subscribe failed" } Log.d(TAG, msg) Toast.makeText(baseContext, msg, Toast.LENGTH_SHORT).show() }
Java
FirebaseMessaging.getInstance().subscribeToTopic("weather") .addOnCompleteListener(new OnCompleteListener<Void>() { @Override public void onComplete(@NonNull Task<Void> task) { String msg = "Subscribed"; if (!task.isSuccessful()) { msg = "Subscribe failed"; } Log.d(TAG, msg); Toast.makeText(MainActivity.this, msg, Toast.LENGTH_SHORT).show(); } });
Per annullare l'iscrizione, l'app client chiama Firebase Cloud Messaging unsubscribeFromTopic()
con il nome dell'argomento.
Ricevere e gestire i messaggi degli argomenti
FCM consegna i messaggi degli argomenti come gli altri messaggi downstream.
Per ricevere messaggi, utilizza un servizio che si estende
FirebaseMessagingService
.
Il tuo servizio deve sostituire i callback onMessageReceived
e onDeletedMessages
.
La finestra temporale per la gestione di un messaggio potrebbe essere inferiore a 20 secondi, a seconda dei ritardi riscontrati prima della chiamata al numero onMessageReceived
, inclusi ritardi del sistema operativo, tempo di avvio dell'app, blocco del thread principale da parte di altre operazioni o tempi di chiamata onMessageReceived
precedenti. Dopodiché, vari comportamenti del sistema operativo, come l'interruzione dei processi di Android o i
limiti di esecuzione in background di Android O, potrebbero interferire con la tua capacità di completare il lavoro.
onMessageReceived
è fornito per la maggior parte dei tipi di messaggi, con le seguenti
eccezioni:
-
Messaggi di notifica recapitati quando l'app è in background. In questo caso, la notifica viene inviata alla barra delle applicazioni del dispositivo. Quando un utente tocca una notifica, per impostazione predefinita si apre Avvio app.
-
Messaggi con payload di notifica e dati, se ricevuti in background. In questo caso, la notifica viene inviata alla barra delle app del dispositivo e il payload dei dati viene inviato negli extra dell'intent dell'attività del programma di avvio.
In sintesi:
Stato dell'app | Notifica | Dati | Entrambe |
---|---|---|---|
Primo piano | onMessageReceived |
onMessageReceived |
onMessageReceived |
Contesto | Barra delle app | onMessageReceived |
Notifica: riquadro delle app Dati: negli extra dell'intent. |
Modificare il file manifest dell'app
Per utilizzare FirebaseMessagingService
, devi aggiungere quanto segue nel
file manifest dell'app:
<service android:name=".java.MyFirebaseMessagingService" android:exported="false"> <intent-filter> <action android:name="com.google.firebase.MESSAGING_EVENT" /> </intent-filter> </service>
Ti consigliamo inoltre di impostare valori predefiniti per personalizzare l'aspetto delle notifiche. Puoi specificare un'icona predefinita personalizzata e un colore predefinito personalizzato che vengono applicati ogni volta che i valori equivalenti non sono impostati nel payload della notifica.
Aggiungi queste righe all'interno del tag application
per impostare l'icona predefinita e il colore personalizzati:
<!-- Set custom default icon. This is used when no icon is set for incoming notification messages. See README(https://goo.gl/l4GJaQ) for more. --> <meta-data android:name="com.google.firebase.messaging.default_notification_icon" android:resource="@drawable/ic_stat_ic_notification" /> <!-- Set color used with incoming notification messages. This is used when no color is set for the incoming notification message. See README(https://goo.gl/6BKBk7) for more. --> <meta-data android:name="com.google.firebase.messaging.default_notification_color" android:resource="@color/colorAccent" />
Android mostra l'icona predefinita personalizzata
- Tutti i messaggi di notifica inviati dal Editor di notifiche.
- Qualsiasi messaggio di notifica che non imposta esplicitamente l'icona nel payload di notifica.
Android utilizza il colore predefinito personalizzato per
- Tutti i messaggi di notifica inviati dal Editor di notifiche.
- Qualsiasi messaggio di notifica che non imposta esplicitamente il colore nel payload di notifica.
Se non è impostata un'icona predefinita personalizzata e non è impostata alcuna icona nel payload della notifica, Android mostra l'icona dell'applicazione visualizzata in bianco.
Esegui l'override di onMessageReceived
Sostituendo il metodo FirebaseMessagingService.onMessageReceived
,
puoi eseguire azioni in base all'oggetto RemoteMessage ricevuto e recuperare i dati del messaggio:
Kotlin+KTX
override fun onMessageReceived(remoteMessage: RemoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: ${remoteMessage.from}") // Check if message contains a data payload. if (remoteMessage.data.isNotEmpty()) { Log.d(TAG, "Message data payload: ${remoteMessage.data}") // Check if data needs to be processed by long running job if (needsToBeScheduled()) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob() } else { // Handle message within 10 seconds handleNow() } } // Check if message contains a notification payload. remoteMessage.notification?.let { Log.d(TAG, "Message Notification Body: ${it.body}") } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Java
@Override public void onMessageReceived(RemoteMessage remoteMessage) { // TODO(developer): Handle FCM messages here. // Not getting messages here? See why this may be: https://goo.gl/39bRNJ Log.d(TAG, "From: " + remoteMessage.getFrom()); // Check if message contains a data payload. if (remoteMessage.getData().size() > 0) { Log.d(TAG, "Message data payload: " + remoteMessage.getData()); if (/* Check if data needs to be processed by long running job */ true) { // For long-running tasks (10 seconds or more) use WorkManager. scheduleJob(); } else { // Handle message within 10 seconds handleNow(); } } // Check if message contains a notification payload. if (remoteMessage.getNotification() != null) { Log.d(TAG, "Message Notification Body: " + remoteMessage.getNotification().getBody()); } // Also if you intend on generating your own notifications as a result of a received FCM // message, here is where that should be initiated. See sendNotification method below. }
Sostituisci onDeletedMessages
In alcuni casi, FCM potrebbe non inviare un messaggio. Questo accade quando ci sono troppi messaggi (>100) in attesa per la tua app su un determinato dispositivo al momento della connessione o se il dispositivo non si è connesso a FCM da più di un mese. In questi casi,
puoi ricevere un callback a FirebaseMessagingService.onDeletedMessages()
Quando l'istanza dell'app riceve questo callback,
dovrebbe eseguire una sincronizzazione completa con il server dell'app. Se non hai inviato un messaggio all'app su quel dispositivo nelle ultime 4 settimane, FCM non chiamerà onDeletedMessages()
.
Gestire i messaggi di notifica in un'app in background
Quando l'app è in background, Android indirizza i messaggi di notifica alla barra delle applicazioni. Se un utente tocca la notifica, viene aperto Avvio app per impostazione predefinita.
Sono inclusi i messaggi che contengono sia il payload di notifica sia quello di dati (e tutti i messaggi inviati dalla console Notifiche). In questi casi, la notifica viene inviata alla barra delle app del dispositivo e il payload dei dati viene inviato negli extra dell'intent della tua attività di Avvio.
Per informazioni sulla consegna dei messaggi nella tua app, consulta la dashboard dei report FCM, che registra il numero di messaggi inviati e aperti sui dispositivi Apple e Android, insieme ai dati per le "impressioni" (notifiche visualizzate dagli utenti) per le app per Android.
Crea richieste di invio
Dopo aver creato un argomento, sottoscrivendo le istanze dell'app client all'argomento sul lato client o tramite l'API server, puoi inviare messaggi all'argomento. Se è la prima volta che crei richieste di invio per FCM, consulta la guida relativa al tuo ambiente server e a FCM per informazioni importanti di contesto e configurazione.
Nella logica di invio sul backend, specifica il nome dell'argomento preferito come mostrato di seguito:
Node.js
// The topic name can be optionally prefixed with "/topics/".
const topic = 'highScores';
const message = {
data: {
score: '850',
time: '2:45'
},
topic: topic
};
// Send a message to devices subscribed to the provided topic.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Java
// The topic name can be optionally prefixed with "/topics/".
String topic = "highScores";
// See documentation on defining a message payload.
Message message = Message.builder()
.putData("score", "850")
.putData("time", "2:45")
.setTopic(topic)
.build();
// Send a message to the devices subscribed to the provided topic.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Python
# The topic name can be optionally prefixed with "/topics/".
topic = 'highScores'
# See documentation on defining a message payload.
message = messaging.Message(
data={
'score': '850',
'time': '2:45',
},
topic=topic,
)
# Send a message to the devices subscribed to the provided topic.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Vai
// The topic name can be optionally prefixed with "/topics/".
topic := "highScores"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Topic: topic,
}
// Send a message to the devices subscribed to the provided topic.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
C#
// The topic name can be optionally prefixed with "/topics/".
var topic = "highScores";
// See documentation on defining a message payload.
var message = new Message()
{
Data = new Dictionary<string, string>()
{
{ "score", "850" },
{ "time", "2:45" },
},
Topic = topic,
};
// Send a message to the devices subscribed to the provided topic.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
REST
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"topic" : "foo-bar",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message"
}
}
}
Comando cURL:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"message": {
"topic" : "foo-bar",
"notification": {
"body": "This is a Firebase Cloud Messaging Topic Message!",
"title": "FCM Message"
}
}
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Per inviare un messaggio a una combinazione di argomenti,
specifica una condizione, ovvero un'espressione booleana che specifica gli argomenti di destinazione. Ad esempio, la seguente condizione invierà messaggi ai dispositivi iscritti a TopicA
e TopicB
o TopicC
:
"'TopicA' in topics && ('TopicB' in topics || 'TopicC' in topics)"
FCM valuta prima le eventuali condizioni tra parentesi e poi l'espressione da sinistra a destra. Nell'espressione precedente, un utente
sottoscritto a un singolo argomento non riceve il messaggio. Allo stesso modo, un utente che non
si abbona a TopicA
non riceve il messaggio. Queste combinazioni lo fanno
ricevere:
TopicA
eTopicB
TopicA
eTopicC
Puoi includere fino a cinque argomenti nell'espressione condizionale.
Per inviare un messaggio a una condizione:
Node.js
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
const condition = '\'stock-GOOG\' in topics || \'industry-tech\' in topics';
// See documentation on defining a message payload.
const message = {
notification: {
title: '$FooCorp up 1.43% on the day',
body: '$FooCorp gained 11.80 points to close at 835.67, up 1.43% on the day.'
},
condition: condition
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
console.log('Successfully sent message:', response);
})
.catch((error) => {
console.log('Error sending message:', error);
});
Java
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
String condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
Message message = Message.builder()
.setNotification(Notification.builder()
.setTitle("$GOOG up 1.43% on the day")
.setBody("$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.")
.build())
.setCondition(condition)
.build();
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
String response = FirebaseMessaging.getInstance().send(message);
// Response is a message ID string.
System.out.println("Successfully sent message: " + response);
Python
# Define a condition which will send to devices which are subscribed
# to either the Google stock or the tech industry topics.
condition = "'stock-GOOG' in topics || 'industry-tech' in topics"
# See documentation on defining a message payload.
message = messaging.Message(
notification=messaging.Notification(
title='$GOOG up 1.43% on the day',
body='$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.',
),
condition=condition,
)
# Send a message to devices subscribed to the combination of topics
# specified by the provided condition.
response = messaging.send(message)
# Response is a message ID string.
print('Successfully sent message:', response)
Vai
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
condition := "'stock-GOOG' in topics || 'industry-tech' in topics"
// See documentation on defining a message payload.
message := &messaging.Message{
Data: map[string]string{
"score": "850",
"time": "2:45",
},
Condition: condition,
}
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
response, err := client.Send(ctx, message)
if err != nil {
log.Fatalln(err)
}
// Response is a message ID string.
fmt.Println("Successfully sent message:", response)
C#
// Define a condition which will send to devices which are subscribed
// to either the Google stock or the tech industry topics.
var condition = "'stock-GOOG' in topics || 'industry-tech' in topics";
// See documentation on defining a message payload.
var message = new Message()
{
Notification = new Notification()
{
Title = "$GOOG up 1.43% on the day",
Body = "$GOOG gained 11.80 points to close at 835.67, up 1.43% on the day.",
},
Condition = condition,
};
// Send a message to devices subscribed to the combination of topics
// specified by the provided condition.
string response = await FirebaseMessaging.DefaultInstance.SendAsync(message);
// Response is a message ID string.
Console.WriteLine("Successfully sent message: " + response);
REST
POST https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Content-Type: application/json
Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
{
"message":{
"condition": "'dogs' in topics || 'cats' in topics",
"notification" : {
"body" : "This is a Firebase Cloud Messaging Topic Message!",
"title" : "FCM Message",
}
}
}
Comando cURL:
curl -X POST -H "Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA" -H "Content-Type: application/json" -d '{
"notification": {
"title": "FCM Message",
"body": "This is a Firebase Cloud Messaging Topic Message!",
},
"condition": "'dogs' in topics || 'cats' in topics"
}' https://fcm.googleapis.com/v1/projects/myproject-b5ae1/messages:send HTTP/1.1
Passaggi successivi
- Puoi utilizzare il server per sottoscrivere le istanze dell'app client agli argomenti e svolgere altre attività di gestione. Consulta Gestire le sottoscrizioni agli argomenti sul server.