Premiers pas avec Firebase Remote Config

.


Vous pouvez utiliser Firebase Remote Config pour définir des paramètres dans votre application et mettre à jour leurs valeurs dans le cloud, ce qui vous permet de modifier l'apparence et le comportement sans distribuer de mise à jour. Ce guide vous explique les étapes à suivre pour vous lancer et fournit quelques exemple de code.

Étape 1: Ajoutez Firebase et le SDK Remote Config à votre application

  1. Installez et initialisez les SDK Firebase pour Flutter si vous : ne l'avez pas déjà fait.

  2. Pour Remote Config, Google Analytics est requis pour Ciblage conditionnel des instances d'application aux propriétés utilisateur et aux audiences. Vérifiez que vous activez Google Analytics dans votre projet.

  3. À partir du répertoire racine de votre projet Flutter, exécutez la commande suivante : pour installer le plug-in Remote Config:

    flutter pub add firebase_remote_config
    

    De plus, lors de la configuration de Remote Config, vous devez ajouter le SDK Firebase pour Google Analytics dans votre application:

    flutter pub add firebase_analytics
    
  4. Recompilez votre projet:

    flutter run
    
  5. Si vous utilisez Remote Config sous macOS, activez Partage de trousseaux dans Xcode.

Étape 2: Récupérez l'objet Singleton Remote Config

Obtenez une instance d'objet Remote Config et définissez Intervalle de récupération minimal requis pour des actualisations fréquentes:

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(hours: 1),
));

L'objet singleton permet de stocker les valeurs de paramètre par défaut dans l'application, d'extraire les valeurs de paramètre mises à jour depuis le backend, et contrôler à quel moment les valeurs sont récupérées mis à la disposition de votre application.

Pendant le développement, nous vous recommandons de définir une valeur d'extraction minimale relativement faible l'intervalle. Pour en savoir plus, consultez la section Limitation.

Étape 3: Définissez les valeurs des paramètres par défaut dans l'application

Vous pouvez définir des valeurs de paramètres par défaut dans l'application dans Remote Config , afin que votre application se comporte comme prévu avant de se connecter backend Remote Config, et pour que les valeurs par défaut soient disponibles si aucune dans le backend.

await remoteConfig.setDefaults(const {
    "example_param_1": 42,
    "example_param_2": 3.14159,
    "example_param_3": true,
    "example_param_4": "Hello, world!",
});

Étape 4 : Obtenez les valeurs de paramètre à utiliser dans votre application

Vous pouvez maintenant obtenir les valeurs des paramètres de l'objet Remote Config. Si vous définissez dans le backend, les récupérer, puis les activer, ces valeurs sont disponibles pour votre application. Sinon, vous obtenez Valeurs de paramètre configurées avec setDefaults().

Pour obtenir ces valeurs, appelez la méthode listée ci-dessous qui correspond au type de données attendu par votre application, en fournissant la clé de paramètre comme argument :

  • getBool()
  • getDouble()
  • getInt()
  • getString()

Étape 5: Définissez les valeurs de paramètre dans le backend Remote Config

Utiliser la console Firebase ou API backend Remote Config vous pouvez créer des valeurs par défaut côté serveur qui remplacent les valeurs dans l'application en fonction de la logique conditionnelle ou du ciblage utilisateur souhaités. Cette section décrit les étapes permettant de créer ces valeurs dans la console Firebase.

  1. Dans la console Firebase, ouvrez votre projet.
  2. Sélectionnez Remote Config dans le menu pour afficher le tableau de bord Remote Config.
  3. Définissez les paramètres en leur attribuant les mêmes noms que ceux que vous avez définis dans votre application. Pour chaque paramètre, vous pouvez définir une valeur par défaut (qui remplacer éventuellement la valeur par défaut correspondante dans l'application), et vous pouvez aussi définir des valeurs conditionnelles. Pour en savoir plus, consultez la section Paramètres Remote Config et Conditions.

Étape 6: Extrayez et activez les valeurs

  1. Pour récupérer les valeurs de paramètre à partir du backend Remote Config, appelez la méthode fetch(). Toutes les valeurs que vous définissez dans le backend sont récupérées. et stocké dans l'objet Remote Config.

  2. Pour que les valeurs des paramètres récupérées soient disponibles pour votre application, appelez la méthode activate().

    Dans les cas où vous souhaitez récupérer et activer des valeurs en un seul appel, Utilisez une requête fetchAndActivate() pour récupérer les valeurs backend Remote Config et mettez-les à la disposition de l'application:

    await remoteConfig.fetchAndActivate();
    

Étant donné que ces nouvelles valeurs de paramètres ont une incidence sur le comportement et l'apparence de votre application, vous devez activer les valeurs récupérées à un moment une expérience fluide pour l'utilisateur, comme la prochaine fois qu'il ouvrira votre l'application. Consultez l'article Stratégies de chargement Remote Config. pour obtenir plus d'informations et d'exemples.

Étape 7 : Écoutez les mises à jour en temps réel

Après avoir récupéré les valeurs des paramètres, vous pouvez utiliser Remote Config en temps réel pour écouter pour obtenir des mises à jour à partir du backend Remote Config. des signaux Remote Config en temps réel pour à vos appareils connectés dès que des mises à jour sont disponibles, et récupère automatiquement après la publication d'une nouvelle version Remote Config.

Notez que Remote Config en temps réel n'est pas disponible pour le Web.

  1. Dans votre application, utilisez onConfigUpdated pour commencer à écouter les mises à jour et récupère automatiquement les nouvelles valeurs de paramètres.

     remoteConfig.onConfigUpdated.listen((event) async {
       await remoteConfig.activate();
    
       // Use the new config values here.
     });
    
  2. La prochaine fois que vous publierez une nouvelle version de votre Remote Config, les appareils qui exécutent votre application et écoutent les modifications activeront la nouvelle configuration.

Limitations

Si une application effectue trop de récupérations en peu de temps, les appels de récupération seront limités et la valeur de la propriété lastFetchStatus de FirebaseRemoteConfig sera RemoteConfigFetchStatus.throttle.

L'intervalle de récupération minimal par défaut pour Remote Config est de 12 heures, ce qui signifie que les configurations ne seront pas extraites du backend plus d'une fois toutes les 12 heures quel que soit le nombre d'appels réellement effectués.

Pendant le développement de l'application, si vous n'utilisez pas Remote Config en temps réel (que nous vous pouvez extraire et activer des configurations très fréquemment, (plusieurs fois par heure) pour vous permettre d'effectuer rapidement des itérations au fur et à mesure que vous développez et testez l'application. Pour faciliter l'itération rapide d'un projet avec un maximum de 10 développeurs, vous vous pouvez définir temporairement un intervalle de récupération minimal faible avec setConfigSettings().

final remoteConfig = FirebaseRemoteConfig.instance;
await remoteConfig.setConfigSettings(RemoteConfigSettings(
    fetchTimeout: const Duration(minutes: 1),
    minimumFetchInterval: const Duration(minutes: 5),
));

Étapes suivantes

Si vous ne l'avez pas déjà fait, explorez les Remote Config cas d'utilisation, et nous allons nous intéresser la documentation sur les concepts clés et les stratégies avancées, notamment: