Qu'est-ce qu'une audience ?

Une audience est une configuration qui peut être assignée à un utilisateur du portail et qui permettra de "filtrer" les objets qui s'afficheront lors de sa navigation.

Par objets, il faut comprendre :

documents
variants
médias

Par défaut, les utilisateurs ont accès à tout ce qui est partagé sur le portail.

L’audience permet donc de garantir la confidentialité de certains documents, variants et médias.

Rappelez-vous qu'une audience permet de filtrer les objets en fonction de leur(s) attribut(s), mais que tous les attributs des objets autorisés seront visibles.

Comment fonctionne une audience ?

Une audience doit être vue comme un filtre appliqué sur votre portail lors de la navigation.

Sans audience, l'utilisateur verra l'intégralité des objets diffusés sur votre portail de marque

Avec une audience, l'utilisateur verra une partie de ces objets, exemple :

Admettons que votre portail diffuse les documents des marques M1 et M2.

Si vous créez une audience qui filtre sur la marque M1, les utilisateurs concernés ne verront que des documents dont l'attribut marque possède la valeur M1

Que dois-je préparer en amont de la configuration ?

Avant de démarrer, il est important de réaliser plusieurs étapes.

Étape 1 : quels sont les filtres que je veux appliquer sur mon type de documents ?

Cela peut paraître idiot, mais il est important de définir le besoin :

Je veux que certains utilisateurs puissent ne voir que les documents "produit" de la marque M1

Étape 2 : Quels sont les données qui me permettent de créer ces filtres ?

Étant donné que je veux filtrer sur la marque M1, je dois posséder une donnée sur mes documents permettant d'effectuer ce filtre.

Dans le cas présent, il apparaît qu'un attribut marque doit être disponible sur mes documents et qu'il doit pouvoir avoir la valeur M1.

Étapes suivantes : Je réitère

Maintenant que vous avez réfléchi à vos filtres sur les documents, je vais également me poser la question pour :

les médias
les variants

Quel est le format d'une audience ?

Structure de base

Une audience est composée :

d'un nom -- qui ne sera affiché qu'en administration
d'une configuration en JSON qui définit les filtres à appliquer

Le JSON possède une base suivante :

{
    "asset": {},
    "document": {
        "produit": {},
        "look": {}
    },
    "variant": {}
}

Voici les caractéristiques de base :

Un attribut asset contiendra les filtres à appliquer sur les médias affichés.
Dans le cas présent, aucun filtre ne sera appliqué (à noter que cela n'est pas forcément un souci, puisque vous pourriez ne pas vouloir filtrer sur les assets).
Un attribut document contiendra les filtres à appliquer sur les documents.
Toutefois, ce filtre doit posséder une sous-structure pour chaque type de document.
Dans l'exemple, nous considérons que votre portail diffuse deux types de documents : des produits et des looks.
Un attribut variants contiendra les filtres à appliquer sur les variants affichés.
Dans le cas présent, aucun filtre ne sera appliqué.

Définition d'un filtre sur un objet

Gardon l'exemple précédent :

Je veux que certains utilisateurs puissent ne voir que les documents "produit" de la marque M1

En admettant que marque soit un attribut de type texte non traduisible et qu'il contienne M1 sur certains documents, alors le filtre sur les documents sera :

{
    "asset": {},
    "document": {
        "produit": {
            "attributes.marque": "M1",
        },
        "look": {}
    },
    "variant": {}
}

"attributes.marque" indique que l'on va filtrer sur l'attribut marque
"M1" indique cet attribut doit avoir cette valeur pour permettre l'affichage du document

La méthode sera la même pour tous les types de documents et tous les types d'objets.

Bien sûr, l'attribut utilisé doit être présent sur l'objet. Il n'est pas possible de filtrer les looks sur l'attribut marque.

Type de filtres

Si vous êtes développeurs et que vous connaissez l'API Quable, vous aurez peut-être remarqué que l'exemple ci-dessus ressemble très fortement aux filtres disponibles sur l'API v5 GET /documents : https://docs.quable.com/reference/getdocumentcollection

Il est donc possible de filtrer sur des attributs, mais aussi pourquoi pas sur des tags…

Voici des exemples en fonction des types d'attributs : https://faq.quable.com/fr/articles/6682112-comment-fonctionnent-les-filtres-des-audiences-selon-le-type-d-attribut-en-json

Pour en savoir plus, consulter notre documentation en ligne :

Mots clés : JSON, filtres, audiences, portail