Puoi utilizzare Firebase Remote Config per definire i parametri nella tua app e aggiornarne i valori nel cloud, in modo da modificare l'aspetto e il comportamento dell'app senza distribuire un aggiornamento.
La libreria Remote Config viene utilizzata per memorizzare i valori parametro predefiniti in-app, recuperare i valori parametro aggiornati dal backend Remote Config e controllare quando i valori recuperati vengono resi disponibili per l'app. Per saperne di più, consulta le strategie di caricamento di Remote Config.
Questa guida illustra i passaggi per iniziare e fornisce del codice di esempio, che è possibile clonare o scaricare dal repository GitHub firebase/quickstart-unity.
Passaggio 1: aggiungi Remote Config all'app
Prima di poter utilizzare Remote Config, devi:
Registra il tuo progetto Unity e configuralo in modo che utilizzi Firebase.
Se il tuo progetto Unity utilizza già Firebase, è già registrato e configurato per Firebase.
Se non hai un progetto Unity, puoi scaricare un'app di esempio.
Aggiungi l'SDK Firebase Unity (in particolare
FirebaseRemoteConfig.unitypackage) al tuo progetto Unity.
Tieni presente che l'aggiunta di Firebase al progetto Unity comporta attività sia nella console Firebase sia nel progetto Unity aperto (ad esempio, scarichi i file di configurazione di Firebase dalla console, quindi li sposti nel progetto Unity).
Passaggio 2: imposta i valori predefiniti dei parametri in-app
Puoi impostare i valori dei parametri predefiniti in-app nell'oggetto Remote Config, in modo che l'app si comporti come previsto prima di connettersi al backend Remote Config e in modo che i valori predefiniti siano disponibili se non sono impostati nel backend.
Per farlo, crea un dizionario di stringhe e compilalo con coppie chiave/valore che rappresentano i valori predefiniti da aggiungere. Se hai già configurato i valori dei parametri di backendRemote Config, puoi scaricare un file contenente queste coppie chiave/valore e utilizzarlo per creare il dizionario di stringhe. Per saperne di più, consulta Scarica i valori predefiniti del modelloRemote Config.
Le proprietà diverse da stringa verranno conversite al tipo della proprietà quando viene chiamato SetDefaultsAsync().
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 => {
Passaggio 3: ottieni i valori parametro da utilizzare nell'app
Ora puoi ottenere i valori dei parametri dall'oggetto Remote Config. Se hai impostato i valori nel backend Remote Config, li hai recuperati e poi li hai attivati, questi valori sono disponibili per la tua app. In caso contrario, ottieni i valori parametro in-app configurati utilizzando SetDefaultsAsync().
Per ottenere questi valori, utilizza GetValue(), fornendo la chiave del parametro come argomento. Viene restituito un valore ConfigValue con proprietà per convertire il valore in vari tipi di base.
Passaggio 4: imposta i valori dei parametri
- Nella console Firebase, apri il progetto.
- Seleziona Remote Config dal menu per visualizzare la dashboard di Remote Config.
- Definisci i parametri con gli stessi nomi di quelli definiti nella tua app. Per ogni parametro, puoi impostare un valore predefinito (che alla fine sostituirà il valore predefinito in-app) e valori condizionali. Per saperne di più, consulta i parametri e le condizioni di Remote Config.
Passaggio 5: recupera e attiva i valori (se necessario)
Per recuperare i valori dei parametri dal backend Remote Config, chiama il metodo
FetchAsync(). Tutti i valori impostati sul backend vengono recuperati e memorizzati nella cache nell'oggetto 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); }
Nel codice precedente, FetchComplete è un metodo la cui firma corrisponde ai parametri di uno dei sovracarichi di ContinueWithOnMainThread().
Nel codice di esempio riportato di seguito, al metodo FetchComplete viene passata l'attività precedente (fetchTask), che consente a FetchComplete di determinare se è stata completata.
Il codice utilizza
Info.LastFetchStatus
per determinare se anche il completamento è andato a buon fine. In questo caso,
i valori del parametro Remote Config vengono attivati utilizzando 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}.");
});
}
I valori recuperati utilizzando
FetchAsync()
vengono memorizzati nella cache localmente al termine del recupero, ma non vengono resi disponibili finché non viene invocato
ActivateAsync(). In questo modo puoi assicurarti che i nuovi valori non vengano applicati
durante il calcolo o in altri momenti che potrebbero causare problemi o comportamenti strani.
Passaggio 6: ascolta gli aggiornamenti in tempo reale
Dopo aver recuperato i valori dei parametri, puoi utilizzare Remote Config in tempo reale per monitorare gli aggiornamenti dal backend Remote Config. Remote Config in tempo reale segnala ai dispositivi connessi quando sono disponibili aggiornamenti e recupera automaticamente le modifiche dopo la pubblicazione di una nuova versione di Remote Config.
Gli aggiornamenti in tempo reale sono supportati dall'SDK Firebase Unity versione 11.0.0 e successive per le piattaforme Android e Apple.
- Nell'app, aggiungi un
OnConfigUpdateListenerper iniziare a monitorare gli aggiornamenti e recuperare automaticamente i valori dei parametri nuovi o aggiornati. Quindi, crea unConfigUpdateListenerEventHandlerper elaborare gli eventi di aggiornamento. L'esempio seguente ascolta gli aggiornamenti e utilizza i valori appena recuperati per visualizzare un messaggio di benvenuto aggiornato.
// 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 volta successiva che pubblichi una nuova versione di Remote Config, i dispositivi su cui è in esecuzione la tua app e che sono in ascolto di modifiche chiameranno il gestore del completamento.
Passaggi successivi
Se non l'hai ancora fatto, consulta i Remote Config casi d'uso e dai un'occhiata ad alcuni dei concetti chiave e della documentazione sulle strategie avanzate, tra cui: