class Analytics

L’instance d’Analytics est accessible depuis window.dsfr.analytics

PROPRIÉTÉS

page

Page

window.dsfr.analytics.page

Getter qui retourne l’instance de Page

site

Site

window.dsfr.analytics.site

Getter qui retourne l’instance de Site

user

User

window.dsfr.analytics.user

Getter qui retourne l’instance de User

search

Search

window.dsfr.analytics.search

Getter qui retourne l’instance de Search

funnel

Funnel

window.dsfr.analytics.funnel

Getter qui retourne l’instance de Funnel

cmp

ConsentManagerPlatform

window.dsfr.analytics.cmp

Getter qui retourne l’instance de ConsentManagerPlatform

opt

Opt

window.dsfr.analytics.opt

Getter qui retourne l’instance de Opt

isReady

Boolean

window.dsfr.analytics.isReady

Getter qui retourne l'état de l'API, à savoir true quand elle est prête à être utilisée.

readiness

Promise

window.dsfr.analytics.readiness

Getter qui retourne une Promise permettant de se synchroniser sur l'API, lorsque celle-ci est prête à être utilisée.

  window.dsfr.analytics.readiness.then(() => {
    // start
  }, () => {
    // error
  }
 );

collection

String

window.dsfr.analytics.collection

Getter qui retourne le mode de récolte des données de la page. Défini dans la configuration (voir propriété collection de la configuration )

• manual : Les données de pages ne sont pas envoyées. Attend l’execution de la fonction collect().
• load : Les données de page sont envoyées automatiquement au chargement de la page. (par défaut)
• full : Les données sont envoyées à chaque changement de path dans l’URL, permettant le support des “Single-page application” (par défaut si dsfr en mode ‘vue’, ‘react’ ou ‘angular’)
• hash : Les données sont envoyées à chaque changement de hash dans l'URL

isActionEnabled

Boolean ou String

window.dsfr.analytics.isActionEnabled

Permet d’activer / désactiver la mesure d'audience des actions au niveau global.

• Par défaut, la mesure d'audience des actions est désactivée.
• Si la valeur est true : la mesure d'audience des actions est activée.
• Si la valeur est false : la mesure d'audience des actions est désactivée.
• Si la valeur est reduce : la mesure d'audience des actions est activée uniquement sur les éléments ayant l'attribut data-fr-analytics-action. (voir [Activer les actions](../actions.md#Activer les actions))

Défini dans la configuration (voir propriété isActionEnabled de la configuration ) Voir Activer les actions pour plus d'informations sur l'activation ou la désactivation des actions au cas par cas.

isDebugging

Boolean

window.dsfr.analytics.isDebugging

Permet d’activer / désactiver le debug Eulerian.

⚠️ le debug Eulerian reste persistant sur la page par le biais du LocalStorage jusqu'à désactivation.

MÉTHODES

push (type, layer)

window.dsfr.analytics.push(type, layer)

Alias de la fonction EA_push d’Eulerian via le package. (voir doc Eulerian https://eulerian.wiki/doku.php?id=fr:quickonboarding:installation_installation_guide#types_d_appels )

reset (clear = false)

window.dsfr.analytics.reset(clear)

Permet de remettre les données dans l'état d’origine de la configuration.

Si le paramètre clear = true => toutes les données sont remises en état indéfini.

collect

window.dsfr.analytics.collect()

Envoie au collector le datalayer constitué par l’ensemble des données consolidées depuis :

• Page
• Site
• User
• Search
• Funnel

USAGE

dsfr.analytics.readiness.then(() => { // l'API analytics est prête à l'utilisation
    dsfr.analytics.isDebugging = true; // active le debugging eulerian
    dsfr.analytics.reset(); // remet les données à l'état de configuration
    dsfr.analytics.user.connect('USER\_ID', 'ENCRYPTED\_EMAIL', true);
    dsfr.analytics.page.path = 'my/virtual/page';
    dsfr.analytics.page.isError = true;
    dsfr.analytics.page.template = 'page404';
    dsfr.analytics.collect(); // envoie les données
});