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

Modifier la configuration à distance par programme

Ce document décrit comment vous pouvez lire et modifier par programme l'ensemble des paramètres et conditions au format JSON connus sous le nom de modèle Remote Config . Cela vous permet d'apporter des modifications de modèle sur le backend que l'application cliente peut récupérer à l'aide de la bibliothèque cliente.

À l'aide de l' API REST Remote Config ou des SDK d'administration décrits dans ce guide, vous pouvez contourner la gestion du modèle dans la console Firebase pour intégrer directement les modifications de Remote Config dans vos propres processus. Par exemple, avec les API backend de Remote Config, vous pouvez:

  • Planification des mises à jour de Remote Config . En utilisant des appels d'API en conjonction avec une tâche cron, vous pouvez modifier les valeurs de configuration à distance selon un calendrier régulier.
  • Importez par lots les valeurs de configuration afin de passer efficacement de votre propre système propriétaire à Firebase Remote Config.
  • Utilisez Remote Config avec Cloud Functions pour Firebase , en modifiant les valeurs de votre application en fonction des événements qui se produisent côté serveur. Par exemple, vous pouvez utiliser Remote Config pour promouvoir une nouvelle fonctionnalité dans votre application, puis désactiver cette promotion automatiquement une fois que vous détectez qu'un nombre suffisant de personnes ont interagi avec la nouvelle fonctionnalité.

Les sections suivantes de ce guide décrivent les opérations que vous pouvez effectuer avec les API backend de Remote Config. Pour consulter du code qui effectue ces tâches via l'API REST, consultez l'un de ces exemples d'applications:

Modifier la configuration à distance à l'aide du SDK Firebase Admin

Le SDK Admin est un ensemble de bibliothèques de serveurs qui vous permettent d'interagir avec Firebase à partir d'environnements privilégiés. En plus d'effectuer des mises à jour de Remote Config, le SDK Admin permet la génération et la vérification des jetons d'authentification Firebase, la lecture et l'écriture à partir de la base de données en temps réel, etc. Pour en savoir plus sur les conditions préalables et la configuration du SDK Admin, consultez Ajouter le SDK Admin Firebase à votre serveur .

Dans un flux de configuration à distance typique, vous pouvez obtenir le modèle actuel, modifier certains paramètres ou groupes de paramètres et conditions, valider le modèle, puis le publier. Avant d'effectuer ces appels d'API, vous devez autoriser les requêtes du SDK.

Initialisez le SDK et autorisez les requêtes API

Lorsque vous initialisez le SDK Admin sans paramètres, le SDK utilise les informations d'identification par défaut de l'application Google et lit les options de la variable d'environnement FIREBASE_CONFIG . Si le contenu de la variable FIREBASE_CONFIG commence par un { il sera analysé comme un objet JSON. Sinon, le SDK suppose que la chaîne est le nom d'un fichier JSON contenant les options.

Par exemple:

 const admin = require('firebase-admin');
admin.initializeApp();
 

Obtenir le modèle de configuration à distance actuel

Lorsque vous travaillez avec des modèles Remote Config, gardez à l'esprit qu'ils sont versionnés et que chaque version a une durée de vie limitée depuis sa création jusqu'au moment où vous la remplacez par une mise à jour: 90 jours, avec une limite totale de 300 versions stockées. Voir Modèles et gestion des versions pour plus d'informations.

Vous pouvez utiliser les API backend pour obtenir la version active actuelle du modèle Remote Config au format JSON. Pour obtenir le modèle:

 function getTemplate() {
  var config = admin.remoteConfig();
  config.getTemplate()
      .then(function (template) {
        console.log('ETag from server: ' + template.etag);
        var templateStr = JSON.stringify(template);
        fs.writeFileSync('config.json', templateStr);
      })
      .catch(function (err) {
        console.error('Unable to get template');
        console.error(err);
      });
}
 

Modifier les paramètres de configuration à distance

Vous pouvez modifier et ajouter par programme des paramètres et des groupes de paramètres Remote Config. Par exemple, à un groupe de paramètres existant nommé "nouveau_menu", vous pouvez ajouter un paramètre pour contrôler l'affichage des informations saisonnières:

 function addParameterToGroup(template) {
  template.parameterGroups['new_menu'].parameters['spring_season'] = {
    defaultValue: {
      useInAppDefault: true
    },
    description: 'spring season menu visibility.',
  };
}
 

L'API vous permet de créer de nouveaux paramètres et groupes de paramètres, ou de modifier les valeurs par défaut, les valeurs conditionnelles et les descriptions. Dans tous les cas, vous devez publier explicitement le modèle après avoir effectué des modifications.

Modifier les conditions de configuration à distance

Vous pouvez modifier et ajouter par programme des conditions de configuration à distance et des valeurs conditionnelles. Par exemple, pour ajouter une nouvelle condition:

 function addNewCondition(template) {
  template.conditions.push({
    name: 'android_en',
    expression: 'device.os == \'android\' && device.country in [\'us\', \'uk\']',
    tagColor: 'BLUE',
  });
}
 

Dans tous les cas, vous devez publier explicitement le modèle après avoir effectué des modifications.

Les API backend de Remote Config fournissent plusieurs conditions et opérateurs de comparaison que vous pouvez utiliser pour modifier le comportement et l'apparence de votre application. Pour en savoir plus sur les conditions et les opérateurs pris en charge pour ces conditions, consultez la référence d'expression conditionnelle .

Valider le modèle de configuration à distance

Si vous le souhaitez, vous pouvez valider vos mises à jour avant de les publier, comme indiqué:

 function validateTemplate(template) {
  admin.remoteConfig().validateTemplate(template)
      .then(function (validatedTemplate) {
        // The template is valid and safe to use.
        console.log('Template was valid and safe to use');
      })
      .catch(function (err) {
        console.error('Template is invalid and cannot be published');
        console.error(err);
      });
}
 

Ce processus de validation vérifie les erreurs telles que les clés dupliquées pour les paramètres et les conditions, les noms de condition non valides ou les conditions inexistantes, ou les étiquettes mal formatées. Par exemple, une demande contenant plus que le nombre de clés autorisé (2000) renverrait le message d'erreur, Param count too large .

Publier le modèle de configuration à distance

Après avoir récupéré un modèle et l'avoir révisé avec les mises à jour souhaitées, vous pouvez ensuite le publier. La publication d'un modèle comme décrit dans cette section remplace tout le modèle de configuration existant par le fichier mis à jour et le nouveau modèle actif reçoit un numéro de version supérieur d'un numéro au modèle qu'il a remplacé.

Si nécessaire, vous pouvez utiliser l'API REST pour revenir à la version précédente . Pour atténuer le risque d'erreurs dans une mise à jour, vous pouvez valider avant la publication .

 function publishTemplate() {
  var config = admin.remoteConfig();
  var template = config.createTemplateFromJSON(
      fs.readFileSync('config.json', 'UTF8'));
  config.publishTemplate(template)
      .then(function (updatedTemplate) {
        console.log('Template has been published');
        console.log('ETag from server: ' + updatedTemplate.etag);
      })
      .catch(function (err) {
        console.error('Unable to publish template.');
        console.error(err);
      });
}
 

Modifier la configuration à distance à l'aide de l'API REST

Cette section décrit les principales fonctionnalités de l'API REST Remote Config à l' https://firebaseremoteconfig.googleapis.com . Pour plus de détails, consultez la référence API .

Obtenez un jeton d'accès pour authentifier et autoriser les demandes d'API

Les projets Firebase prennent en charge les comptes de service Google, que vous pouvez utiliser pour appeler les API de serveur Firebase à partir de votre serveur d'applications ou de votre environnement de confiance. Si vous développez du code localement ou déployez votre application sur site, vous pouvez utiliser les informations d'identification obtenues via ce compte de service pour autoriser les demandes du serveur.

Pour authentifier un compte de service et l'autoriser à accéder aux services Firebase, vous devez générer un fichier de clé privée au format JSON.

Pour générer un fichier de clé privée pour votre compte de service:

  1. Dans la console Firebase, ouvrez Paramètres> Comptes de service .

  2. Cliquez sur Générer une nouvelle clé privée , puis confirmez en cliquant sur Générer la clé .

  3. Stockez en toute sécurité le fichier JSON contenant la clé.

Lors de l'autorisation via un compte de service, vous avez deux choix pour fournir les informations d'identification à votre application. Vous pouvez soit définir la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS , soit transmettre explicitement le chemin d'accès à la clé de compte de service dans le code. La première option est plus sécurisée et est fortement recommandée.

Pour définir la variable d'environnement:

Définissez la variable d'environnement GOOGLE_APPLICATION_CREDENTIALS sur le chemin du fichier JSON qui contient votre clé de compte de service. Cette variable s'applique uniquement à votre session shell actuelle, donc si vous ouvrez une nouvelle session, définissez à nouveau la variable.

Linux ou macOS

 export GOOGLE_APPLICATION_CREDENTIALS="/home/user/Downloads/service-account-file.json"
 

les fenêtres

Avec PowerShell:

 $env:GOOGLE_APPLICATION_CREDENTIALS="C:\Users\username\Downloads\service-account-file.json"
 

Une fois que vous avez terminé les étapes ci-dessus, les informations d'identification par défaut de l'application (ADC) sont en mesure de déterminer implicitement vos informations d'identification, ce qui vous permet d'utiliser les informations d'identification du compte de service lors des tests ou de l'exécution dans des environnements non Google.

Utilisez vos identifiants Firebase avec la bibliothèque cliente des API Google pour votre langue préférée pour récupérer un jeton d'accès OAuth 2.0 de courte durée:

node.js

  function getAccessToken() {
  return admin.credential.applicationDefault().getAccessToken()
      .then(accessToken => {
        return accessToken.access_token;
      })
      .catch(err => {
        console.error('Unable to get access token');
        console.error(err);
      });
} 

Dans cet exemple, la bibliothèque cliente de l'API Google authentifie la demande avec un jeton Web JSON ou JWT. Pour plus d'informations, consultez Jetons Web JSON .

Python

 def _get_access_token():
  """Retrieve a valid access token that can be used to authorize requests.

  :return: Access token.
  """
  credentials = ServiceAccountCredentials.from_json_keyfile_name(
      'service-account.json', SCOPES)
  access_token_info = credentials.get_access_token()
  return access_token_info.access_token 

Java

 private static String getAccessToken() throws IOException {
  GoogleCredential googleCredential = GoogleCredential
      .fromStream(new FileInputStream("service-account.json"))
      .createScoped(Arrays.asList(SCOPES));
  googleCredential.refreshToken();
  return googleCredential.getAccessToken();
} 

Une fois votre jeton d'accès expiré, la méthode d'actualisation du jeton est appelée automatiquement pour récupérer un jeton d'accès mis à jour.

Pour autoriser l'accès à Remote Config, demandez l'étendue https://www.googleapis.com/auth/firebase.remoteconfig .

Modifier le modèle de configuration à distance

Lorsque vous travaillez avec des modèles Remote Config, gardez à l'esprit qu'ils sont versionnés et que chaque version a une durée de vie limitée depuis sa création jusqu'au moment où vous la remplacez par une mise à jour: 90 jours, avec une limite totale de 300 versions stockées. Voir Modèles et gestion des versions pour plus d'informations.

Obtenir le modèle de configuration à distance actuel

Vous pouvez utiliser les API backend pour obtenir la version active actuelle du modèle Remote Config au format JSON. Utilisez les commandes suivantes:

boucle

curl --compressed -D headers -H "Authorization: Bearer token " -X GET https://firebaseremoteconfig.googleapis.com/v1/projects/ my-project-id /remoteConfig -o filename 

Cette commande renvoie la charge utile JSON dans un fichier et les en-têtes (y compris Etag) dans un fichier séparé.

Requête HTTP brute

Host: firebaseremoteconfig.googleapis.com

GET /v1/projects/ my-project-id /remoteConfig HTTP/1.1
Authorization: Bearer token
Accept-Encoding: gzip

Cet appel d'API renvoie le JSON suivant, ainsi qu'un en-tête séparé qui inclut un ETag que vous utilisez pour la demande suivante.

Valider le modèle de configuration à distance

En option, vous pouvez valider vos mises à jour avant de les publier. Validez les mises à jour du modèle en ajoutant à votre demande de publication le paramètre d'URL ?validate_only=true Validate_only ?validate_only=true . Dans la réponse, un code d'état 200 et un etag mis à jour avec le suffixe -0 signifie que votre mise à jour a été validée avec succès. Toute réponse non-200 indique que les données JSON contiennent des erreurs que vous devez corriger avant de publier.

Mettre à jour le modèle de configuration à distance

Après avoir récupéré un modèle et révisé le contenu JSON avec les mises à jour souhaitées, vous pouvez ensuite le publier. La publication d'un modèle comme décrit dans cette section remplace tout le modèle de configuration existant par le fichier mis à jour et le nouveau modèle actif reçoit un numéro de version supérieur d'un numéro au modèle qu'il a remplacé.

Si nécessaire, vous pouvez utiliser l'API REST pour revenir à la version précédente . Pour atténuer le risque d'erreurs dans une mise à jour, vous pouvez valider avant la publication .

boucle

curl --compressed -H "Content-Type: application/json; UTF8" -H "If-Match: last-returned-etag " -H "Authorization: Bearer token " -X PUT https://firebaseremoteconfig.googleapis.com/v1/projects/ my-project-id /remoteConfig -d @ filename 

Pour cette commande curl , vous pouvez spécifier le contenu en utilisant le caractère "@", suivi du nom de fichier.

Requête HTTP brute

Host: firebaseremoteconfig.googleapis.com
PUT /v1/projects/ my-project-id /remoteConfig HTTP/1.1
Content-Length: size
Content-Type: application/json; UTF8
Authorization: Bearer token
If-Match: expected ETag
Accept-Encoding: gzip
JSON_HERE

Comme il s'agit d'une demande d'écriture, l' ETag est modifié par cette commande et un ETag mis à jour est fourni dans les en-têtes de réponse de la commande PUT suivante.

Modifier les conditions de configuration à distance

Vous pouvez modifier par programme les conditions et les valeurs conditionnelles de Remote Config. Avec l'API REST, vous devez modifier le modèle directement pour modifier les conditions avant de publier le modèle.

{
  "conditions": [{
    "name": "android_english",
    "expression": "device.os == 'android' && device.country in ['us', 'uk']",
    "tagColor": "BLUE"
  }, {
    "name": "tenPercent",
    "expression": "percent <= 10",
    "tagColor": "BROWN"
  }],
  "parameters": {
    "welcome_message": {
      "defaultValue": {
        "value": "Welcome to this sample app"
      },
      "conditionalValues": {
        "tenPercent": {
          "value": "Welcome to this new sample app"
        }
      },
      "description": "The sample app's welcome message"
    },
    "welcome_message_caps": {
      "defaultValue": {
        "value": "false"
      },
      "conditionalValues": {
        "android_english": {
          "value": "true"
        }
      },
      "description": "Whether the welcome message should be displayed in all capital letters."
    }
  }
}

Les modifications ci-dessus définissent d'abord un ensemble de conditions, puis définissent les valeurs par défaut et les valeurs des paramètres basés sur des conditions ( valeurs conditionnelles ) pour chaque paramètre. Il ajoute également une description facultative pour chaque élément; comme les commentaires de code, ils sont destinés aux développeurs et ne sont pas affichés dans l'application. Un ETag est également fourni à des fins de contrôle de version.

Les API backend de Remote Config fournissent plusieurs conditions et opérateurs de comparaison que vous pouvez utiliser pour modifier le comportement et l'apparence de votre application. Pour en savoir plus sur les conditions et les opérateurs pris en charge pour ces conditions, consultez la référence d'expression conditionnelle .

Codes d'erreur HTTP

Code d'état Sens
200 Mise à jour réussie
400 Une erreur de validation s'est produite. Par exemple, une demande contenant plus que le nombre de clés autorisé (2000) renverrait 400 (demande incorrecte) avec le message d'erreur, Param count too large . En outre, ce code d'état HTTPS peut se produire dans ces deux situations:
  • Une erreur d'incompatibilité de version s'est produite car l'ensemble de valeurs et de conditions a été mis à jour depuis la dernière récupération d'une valeur ETag. Pour résoudre ce problème, vous devez utiliser une commande GET pour obtenir un nouveau modèle et une nouvelle valeur ETag, mettre à jour le modèle, puis soumettre à l'aide de ce modèle et de la nouvelle valeur ETag.
  • Une commande PUT (demande de modèle Update Remote Config) a été effectuée sans spécifier d'en If-Match tête If-Match .
401 Une erreur d'autorisation s'est produite (aucun jeton d'accès n'a été fourni ou l'API REST Firebase Remote Config n'a pas été ajoutée à votre projet dans la Cloud Developer Console)
403 Une erreur d'authentification s'est produite (le mauvais jeton d'accès a été fourni)
500 Une erreur interne a eu lieu. Si cette erreur se produit, déposez un ticket de support Firebase

Un code d'état de 200 signifie que le modèle de configuration à distance (paramètres, valeurs et conditions du projet) a été mis à jour et est désormais disponible pour les applications qui utilisent ce projet. D'autres codes d'état indiquent que le modèle Remote Config qui existait précédemment est toujours en vigueur.

Après avoir soumis les mises à jour de votre modèle, accédez à la console Firebase pour vérifier que vos modifications s'affichent comme prévu. Ceci est essentiel car l'ordre des conditions affecte la façon dont elles sont évaluées (la première condition qui évalue true prend effet).

Utilisation d'ETag et mises à jour forcées

L'API REST Remote Config utilise une balise d'entité (ETag) pour éviter les conditions de concurrence et le chevauchement des mises à jour des ressources. Pour en savoir plus sur ETags, consultez ETag - HTTP .

Pour l'API REST, Google vous recommande de mettre en cache l'ETag fourni par la commande GET la plus récente et d'utiliser cette valeur ETag dans l'en If-Match tête de requête If-Match lors de l'émission de commandes PUT . Si votre commande PUT entraîne un code d'état HTTPS 409, vous devez émettre une nouvelle commande GET pour acquérir un nouvel ETag et un nouveau modèle à utiliser avec votre prochaine commande PUT .

Vous pouvez contourner l'ETag, et la protection qu'il fournit, en forçant la mise à jour du modèle Remote Config comme suit: If-Match: * Cependant, cette approche n'est pas recommandée car elle risque de provoquer la perte de mises à jour de votre Remote Config template si plusieurs clients mettent à jour le modèle Remote Config. Ce type de conflit peut se produire avec plusieurs clients utilisant l'API ou avec des mises à jour conflictuelles des clients API et des utilisateurs de la console Firebase.

Pour obtenir des conseils sur la gestion des versions de modèle Remote Config, consultez Modèles et gestion des versions de Remote Config .