Configurer une application cliente Firebase Cloud Messaging avec Unity

Pour écrire votre application cliente Firebase Cloud Messaging multiplate-forme avec Unity, utilisez l'API Firebase Cloud Messaging. Le SDK Unity fonctionne à la fois pour Android et Apple, avec une configuration supplémentaire requise pour chaque plate-forme.

Avant de commencer

Prérequis

  • Installez Unity 2021 LTS ou version ultérieure. La prise en charge d'Unity 2020 est considérée comme obsolète et ne sera plus activement prise en charge après la prochaine version majeure. Les versions antérieures peuvent également être compatibles, mais elles ne seront pas activement prises en charge.

  • (Plates-formes Apple uniquement) Installez les éléments suivants :

    • Xcode 13.3.1 ou version ultérieure
    • CocoaPods 1.12.0 ou version ultérieure

  • Assurez-vous que votre projet Unity répond aux exigences suivantes :

    • Pour iOS : cible iOS 13 ou version ultérieure
    • Pour tvOS : cible tvOS 13 ou version ultérieure
    • Pour Android : cible le niveau d'API 21 (Lollipop) ou version ultérieure

  • Configurez un appareil ou utilisez un émulateur pour exécuter votre projet Unity.

    • Pour iOS ou tvOS : configurez un appareil physique pour exécuter votre application, puis effectuez les tâches suivantes :

      • Obtenez une clé d'authentification Apple Push Notification pour votre compte de développeur Apple.
      • Activez les notifications push dans Xcode sous App > Capabilities (Application > Fonctionnalités).

    • Pour Android : les émulateurs doivent utiliser une image d'émulateur avec Google Play.

Si vous ne disposez pas encore d'un projet Unity et que vous souhaitez simplement essayer un produit Firebase, vous pouvez télécharger l'un de nos exemples de démarrage rapide.

Étape 1 : Créez un projet Firebase

Avant de pouvoir ajouter Firebase à votre projet Unity, vous devez créer un projet Firebase pour vous y connecter. Pour en savoir plus sur les projets Firebase, consultez Comprendre les projets Firebase.

Étape 2 : Enregistrez votre application auprès de Firebase

Vous pouvez enregistrer une ou plusieurs applications ou jeux pour les connecter à votre projet Firebase.

  1. Accédez à la console Firebase.

  2. Au centre de la page de présentation du projet, cliquez sur l'icône Unity () pour lancer le workflow de configuration.

    Si vous avez déjà ajouté une application à votre projet Firebase, cliquez sur Ajouter une application pour afficher les options de plate-forme.

  3. Sélectionnez la cible de compilation de votre projet Unity que vous souhaitez enregistrer, ou vous pouvez même enregistrer les deux cibles en même temps.

  4. Saisissez le ou les ID spécifiques à la plate-forme de votre projet Unity.

    • Pour iOS : saisissez l'ID iOS de votre projet Unity dans le champ ID de bundle iOS.

    • Pour Android : saisissez l'ID Android de votre projet Unity dans le champ Nom du package Android.
      Les termes nom de package et ID d'application sont souvent utilisés de manière interchangeable.

  5. (Facultatif) Entrez le ou les surnoms spécifiques à la plate-forme de votre projet Unity.
    Ces surnoms sont des identifiants internes et pratiques. Vous ne les voyez que dans la console Firebase.

  6. Cliquez sur Enregistrer l'application.

Étape 3 : Ajouter des fichiers de configuration Firebase

  1. Obtenez le ou les fichiers de configuration Firebase spécifiques à la plate-forme dans le workflow de configuration de la console Firebase.

    • Pour iOS : cliquez sur Télécharger GoogleService-Info.plist.

    • Pour Android : cliquez sur Télécharger google-services.json.

  2. Ouvrez la fenêtre Project (Projet) de votre projet Unity, puis déplacez vos fichiers de configuration dans le dossier Assets.

  3. De retour dans la console Firebase, dans le workflow de configuration, cliquez sur Suivant.

Étape 4 : Ajouter les SDK Firebase Unity

  1. Dans la console Firebase, cliquez sur Télécharger le SDK Unity Firebase, puis décompressez le SDK dans un emplacement pratique.

    • Vous pouvez télécharger à nouveau le SDK Unity pour Firebase à tout moment.

    • Le SDK Unity Firebase n'est pas spécifique à une plate-forme.

  2. Dans votre projet Unity ouvert, accédez à Assets (Éléments) > Import Package (Importer un package) > Custom Package (Package personnalisé).

  3. Dans le SDK décompressé, sélectionnez les produits Firebase compatibles que vous souhaitez utiliser dans votre application.

    Pour une expérience optimale avec Firebase Cloud Messaging, nous vous recommandons d'activer Google Analytics dans votre projet. En outre, lors de la configuration de Analytics, vous devez ajouter le package Firebase pour Analytics à votre application.

    Analytics activé

    • Ajoutez le package Firebase pour Google Analytics : FirebaseAnalytics.unitypackage
    • Ajoutez le package pour Firebase Cloud Messaging : FirebaseMessaging.unitypackage

    Analytics non activé

    Ajoutez le package pour Firebase Cloud Messaging : FirebaseMessaging.unitypackage

  4. Dans la fenêtre Import Unity Package (Importer un package Unity) qui s'ouvre, cliquez sur Import (Importer).

  5. De retour dans la console Firebase, dans le workflow de configuration, cliquez sur Suivant.

Étape 5 : Vérifier les exigences concernant la version des services Google Play

Le SDK Unity Firebase pour Android nécessite Google Play services, qui doit être à jour avant de pouvoir être utilisé.

Ajoutez l'instruction using et le code d'initialisation suivants au début de votre application. Vous pouvez vérifier si Google Play services est disponible et éventuellement le mettre à jour vers la version requise par le SDK Unity Firebase avant d'appeler d'autres méthodes du SDK.

using Firebase.Extensions;

Firebase.FirebaseApp.CheckAndFixDependenciesAsync().ContinueWithOnMainThread(task => {
  var dependencyStatus = task.Result;
  if (dependencyStatus == Firebase.DependencyStatus.Available) {
    // Create and hold a reference to your FirebaseApp,
    // where app is a Firebase.FirebaseApp property of your application class.
       app = Firebase.FirebaseApp.DefaultInstance;

    // Set a flag here to indicate whether Firebase is ready to use by your app.
  } else {
    UnityEngine.Debug.LogError(System.String.Format(
      "Could not resolve all Firebase dependencies: {0}", dependencyStatus));
    // Firebase Unity SDK is not safe to use here.
  }
});

Votre projet Unity est enregistré et configuré pour utiliser Firebase.

Importer votre clé d'authentification APNs pour l'assistance Apple

Importez votre clé d'authentification d'APN dans Firebase. Si vous ne possédez pas encore de clé d'authentification d'APN, veillez à en créer une dans le Centre des membres Apple Developer.

  1. Dans la console Firebase de votre projet, sélectionnez l'icône en forme de roue dentée, Paramètres du projet, puis l'onglet Cloud Messaging.

  2. Dans Clés d'authentification d'APN, sous Configuration de l'application iOS, cliquez sur le bouton Importer.

  3. Accédez à l'emplacement où vous avez enregistré votre clé, sélectionnez-la, puis cliquez sur Ouvrir. Ajoutez l'ID de la clé (disponible dans le Apple Developer Member Center) et cliquez sur Importer.

Activer les notifications push sur les plates-formes Apple

Étape 1 : Ajoutez le framework de notifications utilisateur

  1. Cliquez sur le projet dans Xcode, puis sélectionnez l'onglet General (Général) dans la zone de l'éditeur.

  2. Faites défiler la page jusqu'à Framework et bibliothèques associés, puis cliquez sur le bouton + pour ajouter un framework.

  3. Dans la fenêtre qui s'affiche, faites défiler la page jusqu'à UserNotifications.framework, cliquez sur cette entrée, puis sur Ajouter.

Étape 2: Activez les notifications push

  1. Cliquez sur le projet dans Xcode, puis sélectionnez l'onglet Fonctionnalités dans la zone de l'éditeur.

  2. Activez l'option Notifications push.

  3. Faites défiler l'écran jusqu'à Modes d'arrière-plan, puis activez l'option.

  4. Cochez la case Notifications à distance sous Modes en arrière-plan.

Initialiser Firebase Cloud Messaging

La bibliothèque Firebase Cloud Messaging est initialisée lorsque vous ajoutez des gestionnaires pour les événements TokenReceived ou MessageReceived.

Lors de l'initialisation, un jeton d'enregistrement est demandé pour l'instance de l'application cliente. L'application recevra le jeton avec l'événement OnTokenReceived, qui doit être mis en cache pour une utilisation ultérieure. Vous aurez besoin de ce jeton si vous souhaitez cibler cet appareil spécifique pour les messages.

En outre, vous devez vous inscrire à l'événement OnMessageReceived si vous souhaitez pouvoir recevoir des messages entrants.

La configuration complète se présente comme suit :

public void Start() {
  Firebase.Messaging.FirebaseMessaging.TokenReceived += OnTokenReceived;
  Firebase.Messaging.FirebaseMessaging.MessageReceived += OnMessageReceived;
}

public void OnTokenReceived(object sender, Firebase.Messaging.TokenReceivedEventArgs token) {
  UnityEngine.Debug.Log("Received Registration Token: " + token.Token);
}

public void OnMessageReceived(object sender, Firebase.Messaging.MessageReceivedEventArgs e) {
  UnityEngine.Debug.Log("Received a new message from: " + e.Message.From);
}

Configurer une activité de point d'entrée Android

Sur Android, Firebase Cloud Messaging est fourni avec une activité de point d'entrée personnalisée qui remplace le UnityPlayerActivity par défaut. Si vous n'utilisez pas de point d'entrée personnalisé, ce remplacement se produit automatiquement et aucune autre action n'est requise. Les applications qui n'utilisent pas l'activité de point d'entrée par défaut ou qui fournissent leur propre Assets/Plugins/AndroidManifest.xml nécessiteront une configuration supplémentaire.

Le plug-in Unity Firebase Cloud Messaging sur Android est fourni avec deux fichiers supplémentaires:

  • Assets/Plugins/Android/libmessaging_unity_player_activity.jar contient une activité appelée MessagingUnityPlayerActivity qui remplace l'UnityPlayerActivity standard.
  • Assets/Plugins/Android/AndroidManifest.xml indique à l'application d'utiliser MessagingUnityPlayerActivity comme point d'entrée.

Ces fichiers sont fournis, car le UnityPlayerActivity par défaut ne gère pas les transitions de cycle de vie des activités onStop et onRestart, ni n'implémente le onNewIntent, qui est nécessaire pour que Firebase Cloud Messaging gère correctement les messages entrants.

Configurer une activité de point d'entrée personnalisé

Si votre application n'utilise pas le UnityPlayerActivity par défaut, vous devez supprimer le AndroidManifest.xml fourni et vous assurer que votre activité personnalisée gère correctement toutes les transitions du cycle de vie de l'activité Android (un exemple est présenté ci-dessous). Si votre activité personnalisée étend UnityPlayerActivity, vous pouvez étendre com.google.firebase.MessagingUnityPlayerActivity, qui implémente toutes les méthodes nécessaires.

Si vous utilisez une activité personnalisée et que vous n'étendez pas com.google.firebase.MessagingUnityPlayerActivity, vous devez inclure les extraits suivants dans votre activité.

/**
 * Workaround for when a message is sent containing both a Data and Notification payload.
 *
 * When the app is in the background, if a message with both a data and notification payload is
 * received the data payload is stored on the Intent passed to onNewIntent. By default, that
 * intent does not get set as the Intent that started the app, so when the app comes back online
 * it doesn't see a new FCM message to respond to. As a workaround, we override onNewIntent so
 * that it sends the intent to the MessageForwardingService which forwards the message to the
 * FirebaseMessagingService which in turn sends the message to the application.
 */
@Override
protected void onNewIntent(Intent intent) {
  Intent message = new Intent(this, MessageForwardingService.class);
  message.setAction(MessageForwardingService.ACTION_REMOTE_INTENT);
  message.putExtras(intent);
  message.setData(intent.getData());
  // For older versions of Firebase C++ SDK (< 7.1.0), use `startService`.
  // startService(message);
  MessageForwardingService.enqueueWork(this, message);
}

/**
 * Dispose of the mUnityPlayer when restarting the app.
 *
 * This ensures that when the app starts up again it does not start with stale data.
 */
@Override
protected void onCreate(Bundle savedInstanceState) {
  if (mUnityPlayer != null) {
    mUnityPlayer.quit();
    mUnityPlayer = null;
  }
  super.onCreate(savedInstanceState);
}

Les nouvelles versions du SDK Firebase C++ (à partir de la version 7.1.0) utilisent JobIntentService, ce qui nécessite des modifications supplémentaires dans le fichier AndroidManifest.xml.

<service android:name="com.google.firebase.messaging.MessageForwardingService"
     android:permission="android.permission.BIND_JOB_SERVICE"
     android:exported="false" >
</service>

Remarque concernant la distribution des messages sur Android

Lorsque l'application ne s'exécute pas du tout et qu'un utilisateur appuie sur une notification, le message n'est pas acheminé par défaut via les rappels intégrés de FCM. Dans ce cas, les charges utiles des messages sont reçues via un Intent utilisé pour démarrer l'application.

Le contenu du champ de notification des messages reçus lorsque l'application est en arrière-plan est utilisé pour renseigner la notification de la barre d'état système, mais ce contenu de notification ne sera pas communiqué à FCM. Autrement dit, FirebaseMessage.Notification sera nul.

En résumé :

État de l'application Notification Données Les deux
Premier plan Firebase.Messaging.FirebaseMessaging.MessageReceived Firebase.Messaging.FirebaseMessaging.MessageReceived Firebase.Messaging.FirebaseMessaging.MessageReceived
Contexte Barre d'état système Firebase.Messaging.FirebaseMessaging.MessageReceived Notification: barre d'état système
Données: dans les extras de l'intent.

Empêcher l'initialisation automatique

FCM génère un jeton d'enregistrement pour le ciblage par appareil. Lorsqu'un jeton est généré, la bibliothèque importe l'identifiant et les données de configuration dans Firebase. Si vous souhaitez obtenir une activation explicite avant d'utiliser le jeton, vous pouvez empêcher sa génération au moment de la configuration en désactivant FCM (et sur Android, Analytics). Pour ce faire, ajoutez une valeur de métadonnées à votre Info.plist (et non à votre GoogleService-Info.plist) sur Apple ou à votre AndroidManifest.xml sur Android :

Android

<?xml version="1.0" encoding="utf-8"?>
<application>
  <meta-data android:name="firebase_messaging_auto_init_enabled"
             android:value="false" />
  <meta-data android:name="firebase_analytics_collection_enabled"
             android:value="false" />
</application>

Swift

FirebaseMessagingAutoInitEnabled = NO

Pour réactiver FCM, vous pouvez effectuer un appel d'environnement d'exécution :

Firebase.Messaging.FirebaseMessaging.TokenRegistrationOnInitEnabled = true;

Une fois définie, cette valeur persiste lors des redémarrages de l'application.

FCM autorise l'envoi de messages contenant un lien profond dans votre application. Pour recevoir des messages contenant un lien profond, vous devez ajouter un nouveau filtre d'intent à l'activité qui gère les liens profonds pour votre application. Le filtre d'intent doit détecter les liens profonds de votre domaine. Si vos messages ne contiennent pas de lien profond, cette configuration n'est pas nécessaire. Dans AndroidManifest.xml:

<intent-filter>
  <action android:name="android.intent.action.VIEW"/>
  <category android:name="android.intent.category.DEFAULT"/>
  <category android:name="android.intent.category.BROWSABLE"/>
  <data android:host="CHANGE_THIS_DOMAIN.example.com" android:scheme="http"/>
  <data android:host="CHANGE_THIS_DOMAIN.example.com" android:scheme="https"/>
</intent-filter>

Vous pouvez également spécifier un caractère générique pour rendre le filtre d'intent plus flexible. Exemple :

<intent-filter>
  <action android:name="android.intent.action.VIEW"/>
  <category android:name="android.intent.category.DEFAULT"/>
  <category android:name="android.intent.category.BROWSABLE"/>
  <data android:host="*.example.com" android:scheme="http"/>
  <data android:host="*.example.com" android:scheme="https"/>
</intent-filter>

Lorsque les utilisateurs appuient sur une notification contenant un lien vers le schéma et l'hôte que vous spécifiez, votre application lance l'activité avec ce filtre d'intent pour gérer le lien.

Étapes suivantes

Après avoir configuré l'application cliente, vous êtes prêt à envoyer des messages thématiques en aval avec Firebase. Pour en savoir plus, consultez l'exemple de démarrage rapide qui illustre cette fonctionnalité.

Pour ajouter un autre comportement plus avancé à votre application, consultez les guides sur l'envoi de messages à partir d'un serveur d'applications:

N'oubliez pas que vous aurez besoin d'une implémentation de serveur pour utiliser ces fonctionnalités.