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 de votre application sans distribuer de mise à jour d'application. Ce guide vous guide à travers les étapes de démarrage et fournit des exemples de code, qui sont tous disponibles pour cloner ou télécharger à partir du référentiel firebase/quickstart-ios GitHub.

Ajouter Remote Config à votre application

  1. Installez le SDK Firebase pour les plates-formes Apple.

  2. Créez l'objet singleton Remote Config, comme illustré dans l'exemple suivant :

    Rapide

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

    Objectif c

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

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

Au cours du développement, il est recommandé de définir un intervalle d'extraction minimal relativement faible. Voir Limitation pour plus d'informations.

Définir les valeurs des paramètres par défaut 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 pour que les valeurs par défaut soient disponibles si aucune n'est définie dans le backend.

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

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

    LE REPOS

    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 et sélectionnez Télécharger les valeurs par défaut .

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

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

    Rapide

    remoteConfig.setDefaults(fromPlist: "RemoteConfigDefaults")

    Objectif c

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

Obtenir les valeurs des paramètres à utiliser dans votre application

Vous pouvez maintenant obtenir des valeurs de paramètre à partir de l'objet Remote Config. Si vous définissez ultérieurement des valeurs dans le backend Remote Config, les récupérez, puis les activez, ces valeurs sont disponibles pour votre application. Sinon, vous obtenez les valeurs des paramètres intégrés à l'application configurées à l'aide setDefaults: . Pour obtenir ces valeurs, appelez la méthode configValueForKey: en fournissant le paramètre key comme argument.

Définir les valeurs des paramètres

À l'aide de la console Firebase ou des API backend de Remote Config , vous pouvez créer de nouvelles valeurs backend par défaut qui remplacent les valeurs intégrées à l'application en fonction de la logique conditionnelle ou du ciblage utilisateur que vous souhaitez. Cette section vous guide à travers les étapes de la console Firebase pour créer ces valeurs.

  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 des paramètres avec les mêmes noms que les paramètres que vous avez définis dans votre application. Pour chaque paramètre, vous pouvez définir une valeur par défaut (qui remplacera éventuellement la valeur par défaut de l'application) et vous pouvez également définir des valeurs conditionnelles. Pour en savoir plus, consultez Paramètres et conditions de configuration à distance .

Récupérer et activer des valeurs

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

Dans les cas où vous souhaitez récupérer et activer des valeurs en un seul appel, utilisez fetchAndActivateWithCompletionHandler: .

Cet exemple récupère les valeurs du backend Remote Config (pas les valeurs mises en cache) et appelle activateWithCompletionHandler: pour les rendre disponibles pour l'application :

Rapide

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()
}

Objectif 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);
    }
}];

Étant donné que ces valeurs de paramètre mises à jour affectent le comportement et l'apparence de votre application, vous devez activer les valeurs extraites à un moment qui garantit une expérience fluide pour votre utilisateur, comme la prochaine fois que l'utilisateur ouvre votre application. Voir Stratégies de chargement de Remote Config pour plus d'informations et d'exemples.

Étranglement

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

Pendant le développement de l'application, vous souhaiterez peut-être actualiser le cache très fréquemment (plusieurs fois par heure) pour vous permettre d'itérer rapidement au fur et à mesure que vous développez et testez votre application. Pour permettre une itération rapide sur un projet avec de nombreux développeurs, vous pouvez temporairement ajouter une propriété FIRRemoteConfigSettings avec un intervalle de récupération minimum faible ( MinimumFetchInterval ) dans votre application.

L'intervalle de récupération de production par défaut et recommandé pour Remote Config est de 12 heures, ce qui signifie que les configurations ne seront pas récupérées plus d'une fois depuis le backend dans une fenêtre de 12 heures, quel que soit le nombre d'appels de récupération réellement effectués. Plus précisément, l'intervalle de récupération minimal est déterminé dans l'ordre suivant :

  1. The parameter in fetch(long)
  2. The parameter in FIRRemoteConfigSettings.MinimumFetchInterval
  3. The default value of 12 hours

Prochaines étapes

If you haven't already, explore the Remote Config use cases , and take a look at some of the key concepts and advanced strategies documentation, including: