🐛 fix(analytics): réduction d'envoi des données [DS-3626]

src/analytics/.package.yml

@@ -19,7 +19,6 @@ script:
   - display
   - table
   - tag
-  - download
 example:
   style:
     - core

src/analytics/doc/analytics.md

@@ -1,26 +1,18 @@
 
 # Analytics
 
-> **Warnning**
-> Version Beta
->  * Les tests sur les données remontées sont toujours en cours.
-Merci de nous informer des problématiques que vous pourriez rencontrer.
->  * Les versions précédentes du DSFR sont en partie supportées.
-> Le périmètre de ce support sera détaillé dans de prochaines versions.
-> L’usage avec d’anciennes versions est livré “AS IS”.
-
-
-> **Note**
->  * Support de IE11
->  * Support des SPA (Angular, React et Vue)
->  * Tous les composants implémentés
->  * Taux de click désactivé par défaut (économie de donnée) et activable via la configuration
->  * Opt out complet supporté
->  * id requis sur les éléments tracés, l’API remonte les id manquants dans la console
+> **Important**
+> La propriété de configuration `enableRating` a été retirée, celle-ci entraînant des envois de données trop importants. En remplacement, un attribut `data-fr-analytics-rating` peut être ajouté sur un élément dont on veut mesurer spécifiquement le taux de click. 
+
+> **Warning**
+> Ce package est prévu pour fonctionner de manière optimale avec la version dsfr-1.9.0 ou suppérieure.
+> L'ajout d'un patch, présent dans `dist/patch/`, permet le support des versions précédentes (à partir de la version dsfr-1.3.0).
+> Pour ce faire, importer `dist/patch/patch.module.min.js` et `dist/patch/patch.nomodule.min.js` après l'élément de configuration window.dsfr.analytics et avant le JS du DSFR.
+> Les différents tests effectués semblent montrer un fonctionnement global sans que nous puissions garantir une compatibilité optimale sur ces versions. N'hésitez pas à nous remonter tous problèmes rencontrés.
+
 
 Le système de design apporte avec lui un outil de collecte de données analytics basé sur la solution Eulérian. Ce package, bien que fourni par le DSFR, peut être utilisé indépendamment de celui-ci via une version standalone.
 
-Ce package est compatible à partir de la version dsfr-1.9.0, pour les versions précédentes l’ajout d'un patch permet unsupport jusqu’à dsfr-1.3.0.
 
 
 - Analytics
@@ -29,12 +21,12 @@ Ce package est compatible à partir de la version dsfr-1.9.0, pour les versions
     - [class ConsentManagerPlatform](analytics/installation/cmp.md)
     - [class Opt](analytics/installation/opt.md)
   - [Collector](analytics/collector.md)
-    - [class Analytics](analytics/classes/analytics.md)
-    - [class Page](analytics/classes/page.md)
-    - [class User](analytics/classes/user.md)
-    - [class Site](analytics/classes/site.md)
-    - [class Search](analytics/classes/search.md)
-    - [class Funnel](analytics/classes/funnel.md)
+    - [class Analytics](analytics/collector/analytics.md)
+    - [class Page](analytics/collector/page.md)
+    - [class User](analytics/collector/user.md)
+    - [class Site](analytics/collector/site.md)
+    - [class Search](analytics/collector/search.md)
+    - [class Funnel](analytics/collector/funnel.md)
   - [Actions](analytics/actions.md)
     - [Actions d’interaction hors composant](analytics/actions/custom-actions.md)
     - [Actions sur les composants DSFR](analytics/actions/component-actions.md)

src/analytics/doc/analytics/actions.md

@@ -1,29 +1,28 @@
 ## Actions
 
-Les actions correspondent aux impressions, aux évènements, ou aux interaction que l’on souhaite traquer. Le suivi de conversion couvre les besoins suivants :
+Les actions correspondent aux évènements et aux interactions que l’on souhaite mesurer. Le suivi de conversion couvre les besoins suivants :
 
 * Suivi d'action immédiate comme un clic sur un bouton, un téléchargement de fichier, …
 
-* Suivi d'action avec une entrée (début=in) et une sortie (validation=out).
+* Suivi d'action avec une entrée (début=in) et une sortie (validation=out) (voir taux d'interaction)
 
 * Captation de paramètres associés à cette action comme des textes renseignés ou des cases cochées.
 
 * Possibilité de gérer des séquences de conversion - création d'un funnel étape par étape.
+
+* Les actions d'interaction sont limitées dans leur envoi à la seule première interaction avec l'élément dans la page, sauf si la donnée associée à l'envoi change. Par exemple, un bouton particulier dans le menu enverra des données au premier click, puis sera limité. Si la page change, il enverra de nouveau des données au premier click. Dans le cas d'un composant de recherche, chaque interaction enverra une requête de recherche différente et passera outre la règle de limitation. Si la requête de recherche est identique à la précédente, celle-ci ne sera pas envoyée.
+
 #### ActionName
 
 Lorsqu’une action est émise, un actionName est envoyé à Eulérian.
 Ce nom d’action est constitué du type d’action, de l’intitulé de l'élément à remonté, de sa hiérarchie, et de son id.
 
-> **Note**
+> **Important**
 > ⚠️ **Un id est obligatoire sur tous les éléments traqués** (retrouvez les éléments du dsfr nécéssitant un id dans la colonne “element” du [tableau d'actions des composants du dsfr](actions/component-actions.md)).
 >Il est nécessaire que l’id soit :
-
 >  * unique : L’id doit être unique au site, ex:
-
 >  * Deux boutons différents ne doivent pas avoir le même id, même sur des pages différentes
-
 >  * Le header peut avoir le même id sur toute les pages s’il est identique
-
 >  * pérenne : L’id doit être le même pour tous les utilisateurs et figé dans le temps.
 
 exemple d’actionName : `(click)_titre_niveau_2_›_titre_niveau_3_›_label_de_l_element_[button-id-1]`
@@ -34,20 +33,16 @@ exemple d’actionName : `(click)_titre_niveau_2_›_titre_niveau_3_›_label_de
 > Les caractères suivants `"'<>*$&~`|\?^~` étant restreints par Eulerian, ils sont remplacés par une équivalence en caractère fullwidth : [Graphemica | Halfwidth and Fullwidth Forms](https://graphemica.com/blocks/halfwidth-and-fullwidth-forms)
 
 
-#### Taux de click
-
-L’API analytics utilise des actions pour suivre les interactions de l’utilisateurs dans et en dehors des composants.
-
-Cette fonctionnalité peut permettre de connaître le taux d’interaction d’un élément, à savoir le rapport entre le nombre de fois où il a été affiché et le nombre de fois où une interaction a eu lieu.
+#### Taux d'interaction
 
-L’activation de cette fonctionnalité se fait d’abord dans le fichier de [configuration](installation/configuration.md) par la propriété `enableRating`
+L’API analytics utilise des actions pour suivre les interactions de l’utilisateur dans et en dehors des composants.
 
-Après avoir été activée, elle sera automatiquement en place sur les composants qui supportent la fonctionnalité (voir dernière colonne dans le [tableau](actions/component-actions.md)).
+L'ajout de l'attribut `data-fr-analytics-rating` sur élément particulier permet d'activer la mesure du taux d’interaction sur cet élément, à savoir le rapport entre le nombre de fois où il a été affiché et le nombre de fois où une interaction a eu lieu.
 
-> ***Note**
-> Cette fonctionnalité peut entraîner un envoi de données très important, puisque chaque composant permettant de suivre le taux de click enverra la donnée d’affichage. Il est important de s’assurer de la pertinence de cette fonctionnalité.
+> **Important**
+> Cette fonctionnalité entraîne un envoi de donnée plus important, la donnée d'affichage étant automatiquement envoyée tandis que l'envoi de la donnée d'interaction se fait à l'intervention de l'utilisateur. Pour rappel, le modèle de facturation dépend du volume d'appels envoyés à Eulerian et l'envoi de multiples affichages de composants entraîne donc une hausse de la consommation de données. Il est important de s’assurer de la pertinence de chaque élément où cette fonctionnalité est activée afin d'optimiser l'envoi de données.
 
 
 - Analytics/Actions
   - [Actions d’interaction hors composant](actions/custom-actions.md)
-  - [Actions sur les composants DSFR](actions/component-actions.md)
+  - [Actions sur les composants DSFR](actions/component-actions.md)