Premiers pas avec Firebase Remote Config

iOS ou version ultérieure Android Web Flutter Unity C++ .

Important :Cette section décrit les étapes à suivre pour configurer Remote Config avec clients mobiles et Web. Pour les environnements de serveur, consultez Utilisez Remote Config dans les environnements de serveur.

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 de votre application sans distribuer de mise à jour. Ce guide vous explique les étapes de démarrage et fournit un exemple de code, cloner ou télécharger à partir de firebase/quickstart-ios. dépôt GitHub.

Étape 1: Ajoutez Remote Config à votre application

1. Si ce n'est pas déjà fait, Ajoutez Firebase à votre projet Apple.

2. Pour Remote Config, Google Analytics est obligatoire pour les 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. Créez l'objet singleton Remote Config, comme illustré dans l'exemple suivant:

   Swift

   remoteConfig = RemoteConfig.remoteConfig()
   let settings = RemoteConfigSettings()
   settings.minimumFetchInterval = 0
   remoteConfig.configSettings = settings
   ViewController.swift

   Objective-C

   self.remoteConfig = [FIRRemoteConfig remoteConfig];
   FIRRemoteConfigSettings *remoteConfigSettings = [[FIRRemoteConfigSettings alloc] init];
   remoteConfigSettings.minimumFetchInterval = 0;
   self.remoteConfig.configSettings = remoteConfigSettings;
   ViewController.m

Cet objet permet de stocker les valeurs de paramètre par défaut dans l'application, de récupérer les valeurs de paramètre mises à jour à partir du backend Remote Config et de contrôler le moment où les valeurs récupérées sont mises à la disposition de votre application.

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

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

Vous pouvez définir des valeurs de paramètre par défaut dans l'application dans l'objet Remote Config afin que votre application se comporte comme prévu avant de se connecter au backend Remote Config et que des valeurs par défaut soient disponibles si aucune n'est définie dans le backend.

Important :Ne stockez pas de données confidentielles dans des clés de paramètre Remote Config ou valeurs. Les données Remote Config sont chiffrées en transit, mais les utilisateurs finaux peuvent y accéder tout paramètre Remote Config par défaut ou récupéré disponible pour leurs l'instance d'application cliente.

1. Définissez un ensemble de noms de paramètres et de valeurs de paramètres par défaut à l'aide d'un NSDictionary ou un fichier plist.

   Si vous avez déjà configuré Remote Config valeurs de paramètre de backend, vous pouvez télécharger un fichier plist généré qui inclut toutes les valeurs par défaut et enregistrez-la dans votre projet Xcode.

   REST

   curl --compressed -D headers -H "Authorization: Bearer token -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/my-project-id/remoteConfig:downloadDefaults?format=PLIST -o RemoteConfigDefaults.plist
   

   Console Firebase

   1. Dans l'onglet Paramètres, ouvrez le menu, puis sélectionnez Télécharger les valeurs par défaut.

   2. Lorsque vous y êtes invité, activez le fichier .plist pour iOS, puis cliquez sur Télécharger le fichier.

2. Ajoutez ces valeurs à l'objet Remote Config à l'aide de setDefaults:. L'exemple suivant définit les valeurs par défaut dans l'application à partir d'un fichier plist :

   Swift

   remoteConfig.setDefaults(fromPlist: "RemoteConfigDefaults")
   ViewController.swift

   Objective-C

   [self.remoteConfig setDefaultsFromPlistFileName:@"RemoteConfigDefaults"];
   ViewController.m

Remarque :Ces extraits de code font référence au fichier RemoteConfigDefaults.plist de l'exemple quickstart-ios projet. Si vous utilisez le fichier de valeurs par défaut téléchargé, utilisez remote_config_defaults.

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

Vous pouvez maintenant obtenir les valeurs des paramètres à partir de l'objet Remote Config. Si, plus tard, définissez des valeurs dans le backend Remote Config, extrayez-les, puis activez-les ces valeurs sont disponibles pour votre application. Sinon, vous obtenez le paramètre "in-app" configurées à l'aide de setDefaults: Pour obtenir ces valeurs, appelez la méthode configValueForKey: , en fournissant la clé de paramètre en tant qu'argument.

Étape 4: Définissez les valeurs des paramètres

À l'aide de la console Firebase ou des API backend Remote Config, vous pouvez créer des valeurs par défaut de backend qui remplacent les valeurs dans l'application en fonction de la logique conditionnelle ou du ciblage utilisateur souhaités. Cette section vous explique comment 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 les Remote Config. tableau de bord.
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 finalement la valeur par défaut dans l'application) et vous pouvez aussi définir des valeurs conditionnelles. Pour en savoir plus, consultez la section Paramètres et conditions Remote Config.

Étape 5: Extrayez et activez les valeurs

Pour récupérer les valeurs de paramètre à partir de Remote Config, appelez la méthode fetchWithCompletionHandler: ou fetchWithExpirationDuration:completionHandler: . Toutes les valeurs que vous définissez sur le backend sont récupérées et mis en cache dans l'objet Remote Config.

Si vous souhaitez récupérer et activer des valeurs en un seul appel, utilisez fetchAndActivateWithCompletionHandler:

Cet exemple extrait des valeurs du backend Remote Config (et non mises en cache) ) et des appelsactivateWithCompletionHandler: pour les mettre à la disposition l'application:

Swift

remoteConfig.fetch { (status, error) -> Void in
  if status == .success {
    print("Config fetched!")
    self.remoteConfig.activate { changed, error in
      // ...
    }
  } else {
    print("Config not fetched")
    print("Error: \(error?.localizedDescription ?? "No error available.")")
  }
  self.displayWelcome()
}
ViewController.swift

Objective-C

[self.remoteConfig fetchWithCompletionHandler:^(FIRRemoteConfigFetchStatus status, NSError *error) {
    if (status == FIRRemoteConfigFetchStatusSuccess) {
        NSLog(@"Config fetched!");
      [self.remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
        if (error != nil) {
          NSLog(@"Activate error: %@", error.localizedDescription);
        } else {
          dispatch_async(dispatch_get_main_queue(), ^{
            [self displayWelcome];
          });
        }
      }];
    } else {
        NSLog(@"Config not fetched");
        NSLog(@"Error %@", error.localizedDescription);
    }
}];
ViewController.m

É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 6: Écoutez les mises à jour en temps réel

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

Les mises à jour en temps réel sont compatibles avec le SDK Firebase pour les plates-formes Apple (version 10.7.0 ou ultérieure).

Important:Les Remote Config en temps réel nécessitent également Firebase Remote Config l'API Realtime, qui devrait déjà être activée pour vous. Pour le vérifier, ouvrez le Console Google Cloud, sélectionnez votre projet, puis ouvrez la page API et services. L'API doit être activée. S'il est absent ou n'est pas activé, cliquez sur Activer les API et Services, recherchez API Realtime Firebase Remote Config, puis activez-la.

1. Dans votre application, appelez addOnConfigUpdateListener pour commencer à écouter les mises à jour et récupérer automatiquement les valeurs de paramètres nouvelles ou mises à jour. Les éléments suivants : exemple écoute les mises à jour et quand activateWithCompletionHandler est appelé, utilise les valeurs nouvellement récupérées pour afficher un message de bienvenue mis à jour.

   Swift

   remoteConfig.addOnConfigUpdateListener { configUpdate, error in
     guard let configUpdate, error == nil else {
       print("Error listening for config updates: \(error)")
     }
   
     print("Updated keys: \(configUpdate.updatedKeys)")
   
     self.remoteConfig.activate { changed, error in
       guard error == nil else { return self.displayError(error) }
       DispatchQueue.main.async {
         self.displayWelcome()
       }
     }
   }

   Objective-C

   __weak __typeof__(self) weakSelf = self;
   [self.remoteConfig addOnConfigUpdateListener:^(FIRRemoteConfigUpdate * _Nonnull configUpdate, NSError * _Nullable error) {
     if (error != nil) {
       NSLog(@"Error listening for config updates %@", error.localizedDescription);
     } else {
       NSLog(@"Updated keys: %@", configUpdate.updatedKeys);
   
       __typeof__(self) strongSelf = weakSelf;
       [strongSelf.remoteConfig activateWithCompletion:^(BOOL changed, NSError * _Nullable error) {
         if (error != nil) {
           NSLog(@"Activate error %@", error.localizedDescription);
         }
   
         dispatch_async(dispatch_get_main_queue(), ^{
           [strongSelf displayWelcome];
         });
       }];
     }
   }];

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, .

Limitations

Si une application récupère trop de fois sur une courte période, les appels d'extraction sont est limitée et que le SDK renvoie FIRRemoteConfigFetchStatusThrottled Avant la version 6.3.0 du SDK, le La limite était de 5 requêtes de récupération en 60 minutes (les versions plus récentes ont des limites plus permissives).

Conseil : À partir de la version 10.7.0 du SDK des plates-formes Apple, vous pouvez utiliser Remote Config en temps réel pour extraire automatiquement les valeurs de paramètre mises à jour à partir du backend Remote Config dès qu'elles sont publiées, en ignorant tout paramètre d'intervalle de récupération minimal. Vous pouvez utiliser des mises à jour en temps réel plutôt que d'effectuer des récupérations fréquentes pour actualiser le cache. Pour en savoir plus, consultez la section Écouter pour obtenir des mises à jour en temps réel.

Pendant le développement de l'application,il peut être utile d'effectuer une récupération plus fréquente pour actualiser le cache. très fréquemment (plusieurs fois par heure) pour vous permettre d'itérer rapidement et tester votre application. Les mises à jour Remote Config en temps réel contournent automatiquement lorsque la configuration est mise à jour sur le serveur. Pour s'adapter à une itération rapide sur un projet avec de nombreux développeurs, vous pouvez ajouter temporairement Propriété FIRRemoteConfigSettings avec un intervalle de récupération minimal faible (MinimumFetchInterval) dans votre application.

Intervalle de récupération en production par défaut et recommandé 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. Plus précisément, l'intervalle de récupération minimal est déterminé dans l'ordre suivant:

1. Le paramètre dans fetch(long)
2. Le paramètre dans FIRRemoteConfigSettings.MinimumFetchInterval
3. La valeur par défaut est de 12 heures.

N'oubliez pas que ce paramètre est réservé au développement, et non pour une application exécutée en production. Si vous utilisez vous testez votre application auprès d'une petite équipe de développement de 10 personnes. n'atteindrait probablement pas les limites de quota horaires côté service. Mais si vous aviez déployé votre application des milliers d'utilisateurs tests avec un intervalle d'extraction minimal très faible, votre application a probablement atteint ce quota.

É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:

• Gérer Remote Config versions du modèle
• Stratégies de chargement de la configuration