Si vous utilisez des API FCM pour créer des requêtes d'envoi de manière programmatique, vous constaterez peut-être que, au fil du temps, vous gaspillez des ressources en envoyant des messages à des appareils inactifs avec des jetons d'enregistrement obsolètes. Cette situation peut affecter les données de diffusion des messages indiquées dans la console Firebase ou les données exportées vers BigQuery, et se traduire par une baisse importante (mais non valide) des taux de diffusion. Ce guide présente certaines mesures que vous pouvez prendre pour vous assurer d'un ciblage efficace des messages et de rapports de diffusion valides.
Jetons d'enregistrement obsolètes et arrivés à expiration
Les jetons d'enregistrement obsolètes sont des jetons associés à des appareils inactifs qui ne se sont pas connectés à FCM depuis plus d'un mois. Au fil du temps, il devient de moins en moins probable que l'appareil se reconnecte à FCM. Il est peu probable que les envois de messages et les diffusions de sujets pour ces jetons obsolètes soient jamais distribués.
Un jeton peut devenir obsolète pour plusieurs raisons. Par exemple, l'appareil auquel le jeton est associé peut être perdu, détruit ou mis en stockage et oublié.
Lorsque les jetons obsolètes atteignent 270 jours d'inactivité, FCM les considère comme des jetons expirés. Une fois qu'un jeton expire, FCM le marque comme non valide et refuse les envois qui lui sont destinés. Toutefois, FCM émet un nouveau jeton pour l'instance de l'application dans le cas rare où l'appareil se reconnecte et que l'application est ouverte.
Bonnes pratiques de base
Vous devez suivre certaines pratiques fondamentales dans toute application qui utilise des API FCM pour créer des requêtes d'envoi par programmation. Voici les principales bonnes pratiques:
- Récupérez les jetons d'enregistrement à partir de FCM et stockez-les sur votre serveur. Le serveur a un rôle important : il doit suivre le jeton de chaque client et conserver une liste à jour des jetons actifs. Nous vous recommandons vivement d'implémenter un code temporel de jeton dans votre code et vos serveurs, et de le mettre à jour à intervalles réguliers.
- Maintenez la fraîcheur des jetons et supprimez les jetons obsolètes. En plus de supprimer les jetons que FCM ne considère plus comme valides, vous pouvez surveiller d'autres signes indiquant que les jetons sont obsolètes et les supprimer de manière proactive. Ce guide présente certaines des options à votre disposition.
Récupérer et stocker des jetons d'enregistrement
Au démarrage initial de votre application, le SDK FCM génère un jeton d'enregistrement pour l'instance de l'application cliente. Il s'agit du jeton que vous devez inclure dans les requêtes d'envoi ciblées à partir de l'API ou ajouter aux abonnements aux sujets pour cibler des sujets.
Nous vous recommandons vivement de récupérer ce jeton au démarrage initial de votre application et de l'enregistrer sur votre serveur d'application avec un code temporel. Ce code temporel doit être implémenté par votre code et vos serveurs, car il n'est pas fourni par les SDK FCM.
Il est également important d'enregistrer le jeton sur le serveur et de mettre à jour le code temporel chaque fois qu'il change, par exemple:
- L'application est restaurée sur un nouvel appareil
- L'utilisateur désinstalle ou réinstalle l'application
- L'utilisateur efface les données de l'application
- L'application redevient active une fois que FCM a expiré son jeton existant.
Exemple: stocker des jetons et des codes temporels dans Cloud Firestore
Par exemple, vous pouvez utiliser Cloud Firestore pour stocker des jetons dans une collection appelée fcmTokens. Chaque ID de document de la collection correspond à un ID utilisateur, et le document stocke le jeton d'enregistrement actuel et son code temporel de dernière mise à jour. Utilisez la fonction set comme indiqué dans cet exemple Kotlin:
/**
* Persist token to third-party servers.
*
* Modify this method to associate the user's FCM registration token with any server-side account
* maintained by your application.
*
* @param token The new token.
*/
private fun sendTokenToServer(token: String?) {
// If you're running your own server, call API to send token and today's date for the user
// Example shown below with Firestore
// Add token and timestamp to Firestore for this user
val deviceToken = hashMapOf(
"token" to token,
"timestamp" to FieldValue.serverTimestamp(),
)
// Get user ID from Firebase Auth or your own server
Firebase.firestore.collection("fcmTokens").document("myuserid")
.set(deviceToken)
}
Chaque fois qu'un jeton est récupéré, il est stocké dans Cloud Firestore en appelant sendTokenToServer:
/**
* Called if the FCM registration token is updated. This may occur if the security of
* the previous token had been compromised. Note that this is called when the
* FCM registration 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
// FCM registration token to your app server.
sendTokenToServer(token)
}
var token = Firebase.messaging.token.await()
// Check whether the retrieved token matches the one on your server for this user's device
val preferences = this.getPreferences(Context.MODE_PRIVATE)
val tokenStored = preferences.getString("deviceToken", "")
lifecycleScope.launch {
if (tokenStored == "" || tokenStored != token)
{
// If you have your own server, call API to send the above token and Date() for this user's device
// Example shown below with Firestore
// Add token and timestamp to Firestore for this user
val deviceToken = hashMapOf(
"token" to token,
"timestamp" to FieldValue.serverTimestamp(),
)
// Get user ID from Firebase Auth or your own server
Firebase.firestore.collection("fcmTokens").document("myuserid")
.set(deviceToken).await()
}
}
Maintenir la fraîcheur des jetons et supprimer les jetons obsolètes
Il n'est pas toujours simple de déterminer si un jeton est à jour ou obsolète. Pour couvrir tous les cas, vous devez définir un seuil à partir duquel vous considérerez les jetons comme obsolètes. Par défaut, FCM considère qu'un jeton est obsolète si son instance d'application ne s'est pas connectée depuis un mois. Tout jeton datant de plus d'un mois est probablement un appareil inactif. Sinon, un appareil actif aurait actualisé son jeton.
Selon votre cas d'utilisation, un mois peut être trop court ou trop long. C'est donc à vous de déterminer les critères qui vous conviennent.
Détecter les réponses de jeton non valides du backend FCM
Assurez-vous de détecter les réponses de jeton non valides de FCM et de répondre en supprimant de votre système tous les jetons d'enregistrement connus comme non valides ou ayant expiré. Avec l'API HTTP v1, ces messages d'erreur peuvent indiquer que votre requête d'envoi ciblait des jetons non valides ou expirés:
UNREGISTERED(HTTP 404)INVALID_ARGUMENT(HTTP 400)
Si vous êtes certain que la charge utile du message est valide et que vous recevez l'une de ces réponses pour un jeton ciblé, vous pouvez supprimer votre enregistrement de ce jeton, car il ne sera plus jamais valide. Par exemple, pour supprimer les jetons non valides de Cloud Firestore, vous pouvez déployer et exécuter une fonction semblable à celle-ci:
// Registration token comes from the client FCM SDKs
const registrationToken = 'YOUR_REGISTRATION_TOKEN';
const message = {
data: {
// Information you want to send inside of notification
},
token: registrationToken
};
// Send message to device with provided registration token
getMessaging().send(message)
.then((response) => {
// Response is a message ID string.
})
.catch((error) => {
// Delete token for user if error code is UNREGISTERED or INVALID_ARGUMENT.
if (errorCode == "messaging/registration-token-not-registered") {
// If you're running your own server, call API to delete the
token for the user
// Example shown below with Firestore
// Get user ID from Firebase Auth or your own server
Firebase.firestore.collection("fcmTokens").document(user.uid).delete()
}
});
FCM ne renvoie une réponse de jeton non valide que si un jeton a expiré au bout de 270 jours ou si un client s'est explicitement désinscrit. Si vous devez suivre plus précisément l'obsolescence en fonction de vos propres définitions, vous pouvez supprimer de manière proactive les jetons d'enregistrement obsolètes.
Mettre à jour les jetons régulièrement
Nous vous recommandons de récupérer et de mettre à jour régulièrement tous les jetons d'enregistrement sur votre serveur. Pour ce faire, vous devez:
- Ajoutez une logique d'application dans votre application cliente pour récupérer le jeton actuel à l'aide de l'appel d'API approprié (par exemple,
token(completion):pour les plates-formes Apple ougetToken()pour Android), puis envoyez le jeton actuel à votre serveur d'application pour le stocker (avec un code temporel). Il peut s'agir d'une tâche mensuelle configurée pour couvrir tous les clients ou jetons. - Ajoutez une logique de serveur pour mettre à jour le code temporel du jeton à intervalles réguliers, que le jeton ait changé ou non.
Pour obtenir un exemple de logique Android permettant de mettre à jour des jetons à l'aide de WorkManager, consultez Gérer les jetons Cloud Messaging sur le blog Firebase.
Quel que soit le schéma de synchronisation que vous suivez, veillez à mettre à jour les jetons régulièrement. Une fréquence de mise à jour d'une fois par mois offre un bon équilibre entre l'impact sur la batterie et la détection des jetons d'enregistrement inactifs. En effectuant cette actualisation, vous vous assurez également que tout appareil qui devient inactif actualisera son enregistrement lorsqu'il redeviendra actif. Il n'y a aucun avantage à effectuer l'actualisation plus souvent qu'une fois par semaine.
Supprimer les jetons d'enregistrement obsolètes
Avant d'envoyer des messages à un appareil, assurez-vous que le code temporel du jeton d'enregistrement de l'appareil se trouve dans la période de validité. Par exemple, vous pouvez implémenter Cloud Functions for Firebase pour exécuter une vérification quotidienne afin de vous assurer que le code temporel se trouve dans une période définie d'obsolescence, telle que const
EXPIRATION_TIME = 1000 * 60 * 60 * 24 * 30;, puis supprimer les jetons obsolètes:
exports.pruneTokens = functions.pubsub.schedule('every 24 hours').onRun(async (context) => {
// Get all documents where the timestamp exceeds is not within the past month
const staleTokensResult = await admin.firestore().collection('fcmTokens')
.where("timestamp", "<", Date.now() - EXPIRATION_TIME)
.get();
// Delete devices with stale tokens
staleTokensResult.forEach(function(doc) { doc.ref.delete(); });
});
Se désabonner des jetons obsolètes des sujets
Si vous utilisez des sujets, vous pouvez également désenregistrer les jetons obsolètes des sujets auxquels ils sont abonnés. Pour ce faire, procédez comme suit:
- Votre application doit se réabonner aux sujets une fois par mois et chaque fois que le jeton d'enregistrement change. Il s'agit d'une solution d'autoréparation, où les abonnements réapparaissent automatiquement lorsqu'une application redevient active.
- Si une instance d'application est inactive pendant un mois (ou pendant votre propre période d'obsolescence), vous devez la désabonner des sujets à l'aide du SDK Admin Firebase pour supprimer le mappage du jeton sur le sujet du backend FCM.
L'avantage de ces deux étapes est que vos fanouts se produisent plus rapidement, car il y a moins de jetons obsolètes à diffuser, et vos instances d'application obsolètes se réabonnent automatiquement une fois qu'elles sont à nouveau actives.
Mesurer la réussite des diffusions
Pour obtenir une image la plus précise possible de la distribution des messages, il est préférable de n'envoyer des messages qu'aux instances d'application utilisées activement. Cela est particulièrement important si vous envoyez régulièrement des messages à des sujets comportant un grand nombre d'abonnés. Si une partie de ces abonnés est inactive, l'impact sur vos statistiques de distribution peut être important au fil du temps.
Avant de cibler des messages sur un jeton, tenez compte des points suivants:
- Google Analytics, les données capturées dans BigQuery ou d'autres signaux de suivi indiquent-ils que le jeton est actif ?
- Les tentatives de diffusion précédentes ont-elles échoué de manière constante sur une période donnée ?
- Le jeton d'enregistrement a-t-il été mis à jour sur vos serveurs au cours du mois dernier ?
- Pour les appareils Android, l'API Data FCM enregistre-t-elle un pourcentage élevé d'échecs de distribution de messages en raison de
droppedDeviceInactive?
Pour en savoir plus sur la distribution, consultez la section Comprendre la distribution des messages.