Vous pouvez utiliser Firebase Remote Config pour définir des paramètres dans votre application et mettre à jour leurs valeurs dans le cloud, vous permettant ainsi de modifier l'apparence et le comportement de votre application sans distribuer de mise à jour d'application.
La bibliothèque Remote Config est utilisée pour stocker les valeurs des paramètres par défaut dans l'application, récupérer les valeurs des paramètres 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. Pour en savoir plus, consultez Stratégies de chargement de Remote Config .
Ce guide vous guide à travers les étapes de démarrage et fournit des exemples de code, tous disponibles pour être clonés ou téléchargés à partir du référentiel GitHub Firebase/quickstart-unity .
Étape 1 : Ajoutez Remote Config à votre application
Avant de pouvoir utiliser Remote Config , vous devez :
Enregistrez votre projet Unity et configurez-le pour utiliser Firebase.
Si votre projet Unity utilise déjà Firebase, il est déjà enregistré et configuré pour Firebase.
Si vous n'avez pas de projet Unity, vous pouvez télécharger un exemple d'application .
Ajoutez le SDK Firebase Unity (en particulier,
FirebaseRemoteConfig.unitypackage) à votre projet Unity.
Notez que l'ajout de Firebase à votre projet Unity implique des tâches à la fois dans la console Firebase et dans votre projet Unity ouvert (par exemple, vous téléchargez les fichiers de configuration Firebase depuis la console, puis vous les déplacez dans votre projet Unity).
Étape 2 : Définir les valeurs des paramètres par défaut dans l'application
Vous pouvez définir les valeurs des paramètres par défaut de 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.
Pour ce faire, créez un dictionnaire de chaînes et remplissez-le avec des paires clé/valeur représentant les valeurs par défaut que vous souhaitez ajouter. Si vous avez déjà configuré les valeurs des paramètres backend de Remote Config, vous pouvez télécharger un fichier contenant ces paires clé/valeur et l'utiliser pour construire votre dictionnaire de chaînes. Pour plus d'informations, consultez Télécharger les valeurs par défaut du modèle de configuration à distance .
(Les propriétés non-chaînes seront converties au type de la propriété lorsque SetDefaultsAsync() est appelé).
System.Collections.Generic.Dictionary<string, object> defaults =
new System.Collections.Generic.Dictionary<string, object>();
// These are the values that are used if we haven't fetched data from the
// server
// yet, or if we ask for values that the server doesn't have:
defaults.Add("config_test_string", "default local string");
defaults.Add("config_test_int", 1);
defaults.Add("config_test_float", 1.0);
defaults.Add("config_test_bool", false);
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.SetDefaultsAsync(defaults)
.ContinueWithOnMainThread(task => {
Étape 3 : Obtenez les valeurs des paramètres à utiliser dans votre application
Vous pouvez désormais obtenir les valeurs des paramètres à partir de l'objet Remote Config. Si vous définissez 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 dans l'application configurées à l'aide de SetDefaultsAsync() .
Pour obtenir ces valeurs, utilisez GetValue() , en fournissant la clé du paramètre comme argument. Cela renvoie un ConfigValue , qui possède des propriétés permettant de convertir la valeur en différents types de base.
Étape 4 : Connectez votre application dans la console Firebase
Dans la console Firebase , ajoutez votre application à votre projet Firebase.
Étape 5 : Définir les valeurs des paramètres
- Dans la console Firebase , ouvrez votre projet.
- Sélectionnez Remote Config dans le menu pour afficher le tableau de bord Remote Config.
- Définissez des paramètres portant 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 des valeurs conditionnelles. Pour en savoir plus, consultez Paramètres et conditions de Remote Config .
Étape 6 : Récupérer et activer les valeurs (si nécessaire)
Pour récupérer les valeurs des paramètres à partir du backend Remote Config, appelez la méthode FetchAsync() . Toutes les valeurs que vous définissez sur le backend sont récupérées et mises en cache dans l'objet Remote Config.
// Start a fetch request.
// FetchAsync only fetches new data if the current data is older than the provided
// timespan. Otherwise it assumes the data is "recent enough", and does nothing.
// By default the timespan is 12 hours, and for production apps, this is a good
// number. For this example though, it's set to a timespan of zero, so that
// changes in the console will always show up immediately.
public Task FetchDataAsync() {
DebugLog("Fetching data...");
System.Threading.Tasks.Task fetchTask =
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.FetchAsync(
TimeSpan.Zero);
return fetchTask.ContinueWithOnMainThread(FetchComplete);
}
Dans le code ci-dessus, FetchComplete est une méthode dont la signature correspond aux paramètres d'une des surcharges de ContinueWithOnMainThread() .
Dans l'exemple de code ci-dessous, la méthode FetchComplete reçoit la tâche précédente ( fetchTask ), ce qui permet FetchComplete de déterminer si elle est terminée. Le code utilise Info.LastFetchStatus pour déterminer ensuite si la fin a également réussi. Si tel est le cas, les valeurs des paramètres Remote Config sont ensuite activées à l'aide de ActivateAsync() .
private void FetchComplete(Task fetchTask) {
if (!fetchTask.IsCompleted) {
Debug.LogError("Retrieval hasn't finished.");
return;
}
var remoteConfig = FirebaseRemoteConfig.DefaultInstance;
var info = remoteConfig.Info;
if(info.LastFetchStatus != LastFetchStatus.Success) {
Debug.LogError($"{nameof(FetchComplete)} was unsuccessful\n{nameof(info.LastFetchStatus)}: {info.LastFetchStatus}");
return;
}
// Fetch successful. Parameter values must be activated to use.
remoteConfig.ActivateAsync()
.ContinueWithOnMainThread(
task => {
Debug.Log($"Remote data loaded and ready for use. Last fetch time {info.FetchTime}.");
});
}
Les valeurs récupérées à l'aide FetchAsync() sont mises en cache localement une fois la récupération terminée, mais ne sont pas rendues disponibles tant que ActivateAsync() n'est pas invoquée. Cela vous permet de garantir que les nouvelles valeurs ne sont pas appliquées en cours de calcul ou à d'autres moments susceptibles de provoquer des problèmes ou un comportement étrange.
É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 les mises à jour du backend Remote Config. Remote Config en temps réel 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 version de Remote Config.
Les mises à jour en temps réel sont prises en charge par le SDK Firebase Unity v11.0.0+ et versions ultérieures pour les plates-formes Android et Apple.
- Dans votre application, ajoutez un
OnConfigUpdateListenerpour commencer à écouter les mises à jour et récupérer automatiquement toutes les valeurs de paramètres nouvelles ou mises à jour. Créez ensuite unConfigUpdateListenerEventHandlerpour traiter les événements de mise à jour. L'exemple suivant écoute les mises à jour et utilise les valeurs nouvellement récupérées pour afficher un message de bienvenue mis à jour.
// Invoke the listener.
void Start()
{
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
+= ConfigUpdateListenerEventHandler;
}
// Handle real-time Remote Config events.
void ConfigUpdateListenerEventHandler(
object sender, Firebase.RemoteConfig.ConfigUpdateEventArgs args) {
if (args.Error != Firebase.RemoteConfig.RemoteConfigError.None) {
Debug.Log(String.Format("Error occurred while listening: {0}", args.Error));
return;
}
Debug.Log("Updated keys: " + string.Join(", ", args.UpdatedKeys));
// Activate all fetched values and then display a welcome message.
remoteConfig.ActivateAsync().ContinueWithOnMainThread(
task => {
DisplayWelcomeMessage();
});
}
// Stop the listener.
void OnDestroy() {
Firebase.RemoteConfig.FirebaseRemoteConfig.DefaultInstance.OnConfigUpdateListener
-= ConfigUpdateListenerEventHandler;
}
La prochaine fois que vous publierez une nouvelle version de votre configuration à distance, les appareils qui exécutent votre application et écoutent les modifications appelleront le gestionnaire d'achèvement.
Next steps
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: