Google is committed to advancing racial equity for Black communities. See how.
Cette page a été traduite par l'API Cloud Translation.
Switch to English

Premiers pas avec Firebase Remote Config sur Android

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

Ajoutez Firebase et le SDK Remote Config à votre application

  1. Si vous ne l'avez pas déjà fait, ajoutez Firebase à votre projet Android .

  2. Pour Remote Config, Google Analytics est requis pour le ciblage conditionnel des instances d'application sur les propriétés des utilisateurs, les audiences et les prédictions Firebase. Assurez-vous d' activer Google Analytics dans votre projet.

  3. Ajoutez la dépendance de la bibliothèque Android Remote Config à votre fichier Gradle de module (au niveau de l'application) (généralement app/build.gradle ).

    De plus, dans le cadre de la configuration d'Analytics, vous devez ajouter le SDK Firebase pour Google Analytics à votre application.

    Java

     implementation 'com.google.firebase:firebase-config:19.2.0'
    implementation 'com.google.firebase:firebase-analytics:17.4.4'
     

    Kotlin + KTX

     implementation 'com.google.firebase:firebase-config-ktx:19.2.0'
    implementation 'com.google.firebase:firebase-analytics-ktx:17.4.4'
     

Obtenez l'objet singleton Remote Config

Obtenez une instance d'objet Remote Config et définissez l'intervalle de récupération minimum pour permettre des actualisations fréquentes:

Java

mFirebaseRemoteConfig = FirebaseRemoteConfig.getInstance();
FirebaseRemoteConfigSettings configSettings = new FirebaseRemoteConfigSettings.Builder()
        .setMinimumFetchIntervalInSeconds(3600)
        .build();
mFirebaseRemoteConfig.setConfigSettingsAsync(configSettings);

Kotlin + KTX

remoteConfig = Firebase.remoteConfig
val configSettings = remoteConfigSettings {
    minimumFetchIntervalInSeconds = 3600
}
remoteConfig.setConfigSettingsAsync(configSettings)

L'objet singleton 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 depuis le backend et contrôler le moment où les valeurs extraites sont mises à disposition de votre application.

Pendant le développement, il est recommandé de définir un intervalle d'extraction minimum 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 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 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 de valeurs de paramètres par défaut à l'aide d'un objet Map ou d'un fichier de ressources XML stocké dans le dossier res/xml votre application. L'exemple d'application de démarrage rapide de Remote Config utilise un fichier XML pour définir les noms et valeurs des paramètres par défaut.
  2. Ajoutez ces valeurs à l'objet Remote Config à l'aide de setDefaultsAsync (int) , comme indiqué:

Java

mFirebaseRemoteConfig.setDefaultsAsync(R.xml.remote_config_defaults);

Kotlin + KTX

remoteConfig.setDefaultsAsync(R.xml.remote_config_defaults)

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

Vous pouvez maintenant obtenir des valeurs de paramètres à partir de l'objet Remote Config. Si vous définissez des valeurs dans le backend, les récupérez, puis les activez, ces valeurs sont disponibles pour votre application. Sinon, vous obtenez les valeurs des paramètres de l'application configurées à l'aide de setDefaultsAsync (int) . Pour obtenir ces valeurs, appelez la méthode répertoriée ci-dessous qui correspond au type de données attendu par votre application, en fournissant la clé de paramètre comme argument:

Définir les valeurs des paramètres dans le backend Remote Config

À l'aide de la console Firebase ou des API backend de Remote Config , vous pouvez créer de nouvelles valeurs par défaut côté serveur qui remplacent les valeurs intégrées à l'application en fonction de la logique conditionnelle souhaitée ou du ciblage des utilisateurs. 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 les 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 correspondante dans 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 les valeurs

  1. Pour récupérer les valeurs des paramètres du backend Remote Config, appelez la méthode fetch () . Toutes les valeurs que vous définissez dans le backend sont extraites et stockées dans l'objet Remote Config.
  2. Pour rendre les valeurs de paramètres récupérées disponibles pour votre application, appelez la méthode activate () .

    Pour les cas où vous souhaitez récupérer et activer des valeurs en un seul appel, vous pouvez utiliser une fetchAndActivate() pour récupérer les valeurs du backend Remote Config et les rendre disponibles pour l'application:

    Java

    mFirebaseRemoteConfig.fetchAndActivate()
            .addOnCompleteListener(this, new OnCompleteListener<Boolean>() {
                @Override
                public void onComplete(@NonNull Task<Boolean> task) {
                    if (task.isSuccessful()) {
                        boolean updated = task.getResult();
                        Log.d(TAG, "Config params updated: " + updated);
                        Toast.makeText(MainActivity.this, "Fetch and activate succeeded",
                                Toast.LENGTH_SHORT).show();
    
                    } else {
                        Toast.makeText(MainActivity.this, "Fetch failed",
                                Toast.LENGTH_SHORT).show();
                    }
                    displayWelcomeMessage();
                }
            });

    Kotlin + KTX

    remoteConfig.fetchAndActivate()
            .addOnCompleteListener(this) { task ->
                if (task.isSuccessful) {
                    val updated = task.result
                    Log.d(TAG, "Config params updated: $updated")
                    Toast.makeText(this, "Fetch and activate succeeded",
                            Toast.LENGTH_SHORT).show()
                } else {
                    Toast.makeText(this, "Fetch failed",
                            Toast.LENGTH_SHORT).show()
                }
                displayWelcomeMessage()
            }

Étant donné que ces valeurs de paramètres 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, par exemple la prochaine fois que l'utilisateur ouvrira votre application. Voir Stratégies de chargement de Remote Config pour plus d'informations et d'exemples.

Étranglement

Si une application est extraite trop de fois sur une courte période, les appels de récupération sont limités et le SDK renvoie FirebaseRemoteConfigFetchThrottledException . Avant la version 17.0.0 du SDK, la limite était de 5 requêtes d'extraction 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 récupérer et activer les configurations très fréquemment (plusieurs fois par heure) pour vous permettre d'itérer rapidement pendant que vous développez et testez votre application. Pour permettre une itération rapide sur un projet comptant jusqu'à 10 développeurs, vous pouvez définir temporairement un objet FirebaseRemoteConfigSettings avec un intervalle de récupération minimum faible ( setMinimumFetchIntervalInSeconds ) dans votre application.

L'intervalle de récupération minimum 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 dans une fenêtre de 12 heures, quel que soit le nombre d'appels d'extraction réellement effectués. Plus précisément, l'intervalle de récupération minimum est déterminé dans l'ordre suivant:

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

Pour définir l'intervalle de récupération minimal sur une valeur personnalisée, utilisez FirebaseRemoteConfigSettings.Builder.setMinimumFetchIntervalInSeconds(long) .

Prochaines étapes

Si vous ne l'avez pas déjà fait, explorez les cas d'utilisation de Remote Config et jetez un œil à certains des concepts clés et de la documentation sur les stratégies avancées, notamment: