Paramètres de configuration pouvant être remplacés

Les paramètres de configuration pouvant être remplacés permettent aux éditeurs de rapports de modifier les valeurs par défaut dans une source de données. Définir des paramètres de configuration comme remplaçables rend une source de données plus flexible et permet aux utilisateurs de créer des modèles de rapport configurables par l'utilisateur.

Par exemple, un connecteur fournissant des données météorologiques peut inclure un paramètre de localisation permettant aux utilisateurs qui consultent un rapport de demander un bulletin météo pour une langue différente de celle par défaut.

Ce document décrit comment les paramètres remplaçables sont définis et peuvent être modifiés, et comment les utilisateurs du rapport peuvent modifier leurs valeurs. Pour en savoir plus sur l'utilisation des paramètres dans Looker Studio, consultez la page Paramètres de source de données.

Rôles

Rôles utilisateur référencés tout au long de ce document:

Rôle Définition
Développeur de connecteurs Un utilisateur qui a créé un connecteur de communauté.
Propriétaire de la source de données Un utilisateur qui a créé une source de données et en est propriétaire.
Éditeur de rapports Utilisateur disposant d'un accès en mode Édition à un rapport.
Lecteur de rapports Un utilisateur disposant d'un accès en mode Vue à un rapport

Définir des paramètres pouvant être remplacés

Le développeur de connecteurs définit les paramètres de configuration dans la fonction getConfig() d'un connecteur de communauté. Pour définir un paramètre de configuration comme pouvant être ignoré, le connecteur appelle setAllowOverride(true).

L'exemple suivant définit deux paramètres remplaçables: zipcode et units, ainsi qu'un paramètre non remplaçable: days-to-forcecast.

Capture d'écran de deux paramètres pouvant être remplacés

function getConfig(request) {
  var config = cc.getConfig();

  // A
  config
      .newTextInput()
      .setId("zipcode")
      .setName("ZIP Code")
      .setAllowOverride(true);

  // B
  config
    .newSelectSingle()
    .setId("units")
    .setName("Units")
    .addOption(
        config
          .newOptionBuilder()
          .setLabel("Metric")
          .setValue("metric")
    )
    .addOption(
      config
        .newOptionBuilder()
        .setLabel("Imperial")
        .setValue("imperial")
    )
    .setAllowOverride(true);

  // C
  config
    .newTextInput()
    .setId("days-to-forecast")
    .setName("Days to forecast")
      .setAllowOverride(false);


  return config.build();
}

Quand éviter de définir un paramètre comme remplaçable ?

Nous vous recommandons de découvrir comment les connecteurs, les sources de données et les rapports fonctionnent les uns avec les autres en consultant l'article Comment Looker Studio se connecte à vos données.

Évitez de définir un paramètre comme remplaçable dans les cas suivants:

  1. Lorsque la valeur d'un paramètre affecte le schéma.
    • Si un utilisateur modifie une valeur de paramètre et que le schéma des nouvelles données renvoyées est différent de celui défini dans la source de données, tout rapport qui en dépend peut ne plus fonctionner en raison de champs manquants.
  2. Si une valeur de paramètre contrôle des données sensibles. (par exemple, "Sélection du compte").
    • Ne définissez pas un paramètre comme remplaçable si vous souhaitez empêcher la consultation ou le partage involontaire de données sensibles.

Activer les paramètres pour les utilisateurs des rapports

Les propriétaires de la source de données déterminent les paramètres pouvant être remplacés par les éditeurs de rapports. De même, les éditeurs de rapports déterminent les paramètres que les lecteurs de rapports peuvent modifier.

Autoriser les éditeurs de rapports à modifier les valeurs des paramètres

Le propriétaire de la source de données contrôle les paramètres pouvant être modifiés dans les rapports. Cette option est configurée lors de la création ou de la modification d'une source de données et n'est applicable qu'aux paramètres définis comme remplaçables par le développeur de connecteurs. Si cette option est activée, les éditeurs de rapports pourront modifier les paramètres d'un rapport.

Dans l'exemple suivant, un connecteur comporte deux paramètres définis comme pouvant être remplacés : zipcode et units. Le propriétaire de la source de données n'a autorisé la modification de zipcode que dans les rapports. Dans le rapport, l'éditeur de rapports peut modifier la valeur du paramètre zipcode.

Activer l'option de remplacement

Autoriser les lecteurs de rapports à modifier les valeurs des paramètres

Les éditeurs de rapports déterminent les paramètres que les lecteurs de rapports peuvent modifier. Les valeurs des paramètres peuvent ensuite être modifiées via l'URL du rapport par n'importe quel lecteur du rapport.

Prenons l'exemple d'un connecteur comportant deux paramètres définis comme pouvant être remplacés : zipcode et units (figure 1). Si le propriétaire de la source de données a autorisé la modification de zipcode dans les rapports (figure 2), les éditeurs de rapports ne pourront autoriser la modification de zipcode que par les lecteurs de rapports. L'éditeur de rapports n'a pas les droits d'accès ni de visibilité nécessaires pour autoriser les lecteurs de rapports à modifier le paramètre units.

Paramètre de code postal activé
Figure 1: Configuration du connecteur

Seul le paramètre "Code postal" peut être modifié
Figure 2: Gestion des paramètres

Paramètres d'URL

Pour autoriser les lecteurs de rapports à modifier les valeurs des paramètres via l'URL du rapport:

  1. Modifiez le rapport.
  2. Sélectionnez Ressource -> Gérer les paramètres d'URL du rapport.
  3. Cochez les cases Autoriser la modification dans l'URL du rapport pour autoriser ou interdire la modification des valeurs de paramètre dans l'URL du rapport. Les modifications sont enregistrées automatiquement.
  4. Cliquez sur Fermer en haut à droite.

Modifier les valeurs des paramètres

Les éditeurs de rapports peuvent modifier les valeurs des paramètres à l'aide du panneau des propriétés des rapports, tandis que les lecteurs de rapports peuvent modifier les valeurs des paramètres via l'URL du rapport.

Panneau des propriétés du rapport

Pour savoir comment un éditeur de rapports peut définir des valeurs de paramètres, consultez Modifier les paramètres dans un rapport.

Paramètres d'URL du rapport

Pour les paramètres autorisés à être modifiés dans l'URL du rapport, les valeurs peuvent être définies via un objet JSON encodé en URL et ajouté à l'URL du rapport en mode Vue.

Pour créer une configuration d'URL:

  1. Recueillir les noms des paramètres

    1. Modifiez le rapport.
    2. Sélectionnez Ressource -> Gérer les paramètres d'URL du rapport.
    3. Notez le nom des paramètres que vous souhaitez définir via l'URL du rapport.

    Par exemple, dans la figure ci-dessous, le nom du paramètre est ds0.zipcode.

    Activation des paramètres d'URL...

  2. Créer l'objet de paramètre

    Les paramètres sont définis via un objet JSON. Les clés des valeurs des paramètres sont les noms des paramètres.

    {
      "parameterName": parameterValue
    }
    

    Les types de valeurs de paramètres sont STRING, NUMBER ou BOOLEAN. Pour les paramètres qui acceptent plusieurs valeurs (par exemple, les listes déroulantes à sélection multiple), utilisez un tableau de valeurs.

    Par exemple, si le nom du paramètre est ds0.zipcode, pour définir le code postal sur 94094, le fichier JSON se présente comme suit:

    {
      "ds0.zipcode": "94094"
    }
    
  3. Encoder l'objet de paramètre en URL

    Après avoir créé l'objet de paramètre, utilisez JSON.stringify() pour le transformer en chaîne, puis utilisez [encodeURIComponent] pour l'encoder en URL.

    var params = {
      "ds0.zipcode": "94094"
    };
    var paramsAsString = JSON.stringify(params);
    var encodedParams = encodeURIComponent(paramsAsString)
    

    Vous obtenez ainsi la chaîne encodée suivante:

    "%7B%22ds0.zipcode%22%3A%2294094%22%7D"
    
  4. Créer l'URL du rapport

    Une fois que vous disposez de l'objet de paramètre encodé au format URL, ajoutez-le à l'URL d'affichage du rapport à l'aide du paramètre de requête params.

    https://lookerstudio.google.com/reporting/REPORT_ID/page/PAGE_ID?params=%7B%22ds0.zipcode%22%3A%2294094%22%7D

    Veillez à remplacer REPORT_ID et PAGE_ID par les valeurs de votre rapport et de votre page.

  5. Utiliser l'URL

    L'URL du rapport remplace les paramètres tels que définis dans l'objet de paramètres JSON en fonction de l'héritage des paramètres.

Exemple d'objet de paramètre

L'objet de paramètre suivant montre comment définir plusieurs paramètres. Vous découvrirez également comment définir des valeurs de paramètres pour les différents types d'entrées.

  • ds0.includeToday est une entrée de case à cocher
  • ds0.units est une entrée à sélection unique.
  • ds1.countries est une entrée à sélection multiple
  • ds1.labelName est une entrée de texte.
  {
    "ds0.includeToday": true,
    "ds0.units": "Metric",
    "ds1.countries": ["Canada", "Mexico"],
    "ds1.labelName": "Population"
  }

Héritage des paramètres

La valeur utilisée pour un paramètre suit un ordre de priorité en fonction de l'endroit où le paramètre est défini. Les paramètres définis pour des emplacements de priorité supérieure remplacent ceux définis pour des emplacements de priorité inférieure. L'ordre de priorité (du plus petit au plus élevé) est le suivant:

  1. Source de données (par défaut)
  2. URL du rapport
  3. Panneau des propriétés du rapport, conformément aux règles d'héritage des paramètres de la source de données.