Poool
light_mode
dark_mode
menu
close

#Configuration

Si besoin, vous pouvez facilement ajuster de nombreuses variables de configuration dans le SDK du paywall Poool.
ℹ️ Ces paramètres sont écrasés par la configuration du Dashboard Poool, sauf s'ils sont définis en lecture seule :

#Utilisation

.config(optionName: String, optionValue: Any, readOnly?: Boolean): this

.config(options: Object, readOnly?: Boolean): this

index.js
// Le 3ème paramètre de la fonction audit.config définit la valeur de configuration
// comme étant en lecture seule (optionnel).
// Elle ne pourra donc pas être écrasée par une valeur du Dashboard.
// true -> lecture seule
// false -> écrasable
audit.config('context', 'my_context', <boolean>);


// Vous pouvez passer une seule valeur en faisant
audit.config('context', 'my_context');


// Mais vous pouvez aussi passer plusieurs valeurs de configuration en utilisant un objet
 audit.config({
  debug: true,
  cookies_enabled: true,
  context: 'my_context',
  custom_segment: 'my_segment',
});


// Vous pouvez utilisez le paramètre `lecture seule` même avec un objet
// ça l'appliquera sur chacune des valeurs de configuration passée dans l'objet
audit.config({
  debug: true,
  cookies_enabled: true,
  context: 'my_context',
  custom_segment: 'my_segment',
}, <boolean>);

#Options

#debug

  • Type: Boolean
  • Défaut: false
Si le mode debug est activé, Poool affichera tout ce qu'il fait dans la console du navigateur.
Exemple
audit.config('debug', true);

#cookies_enabled

  • Type: Boolean
  • Défaut: false
Active/désactive toutes les formes de tracking/identification utilisées par Poool dans le cadre de la conformité RGPD.
Exemple
audit.config('cookies_enabled', true);

#cookies_domain

  • Type: String
  • Défaut: null
Permet de définir un domaine personnalisé pour les cookies déposés par Poool.
Exemple
audit.config('cookies_domain', '.mysite.com');

#context

  • Type: String | String[]
  • Défaut: null
Permet d'assigner à un lecteur un contexte via une ou plusieurs valeurs personnalisées.
Si aucun contexte n'est passé, les contextes natifs ou le contexte par défaut prendront le pas.
Exemple
audit.config('context', 'custom-test-context');


// Il est aussi possible de passer plusieurs valeurs pour affiner le choix du contexte personnalisé
audit.config('context', ['custom-test-context', 'fan', 'category']);

#custom_segment

  • Type: String
  • Défaut: null
Permet d'attribuer à un lecteur un groupe personnalisé défini au préalable dans le Dashboard.
Exemple
audit.config('custom_segment', 'test-segment');

#custom_reader_id

  • Type: String
  • Défaut: null
Permet d'assigner votre propre identifiant unique d'utilisateur à l'un de vos lecteurs.
Exemple
audit.config('custom_reader_id', 'w8t8by4h');

#user_is_premium

  • Type: Boolean
  • Défaut: false
Permet de définir le statut d'un utilisateur comme déjà abonné.
⚠️ Cette valeur n'est utilisée qu'à des fins statistiques.
Exemple
audit.config('user_is_premium', true);

#ati_auto_tracking_enabled

  • Type: Boolean
  • Défaut: false
Permet d'activer le tracking automatique AT Internet (nécessite l'intégration du SDK AT Internet) pour certains events.
⚠️ Nécessite la version 5.7 du SDK AT Internet au minimum.
Exemple
audit.config('ati_auto_tracking_enabled', false);

#ati_tracking_method

  • Type: String
  • Valeurs acceptées: default, events
  • Défaut: default
Permet de choisir la méthode d'envoi des events avec AT Internet (nécessite l'intégration du SDK AT Internet).
Par défaut, tag.publisher.send est utilisée. En choisissant la valeur events, les events seront envoyés via tag.events.send.
⚠️ Nécessite la version 5.7 du SDK AT Internet au minimum.
Exemple
audit.config('ati_tracking_method', 'events');

#piano_auto_tracking_enabled

  • Type: Boolean
  • Défaut: false
Permet d'activer le tracking automatique Piano (nécessite l'intégration du SDK Piano) pour certains events.
Exemple
audit.config('piano_auto_tracking_enabled', false);

#ga_auto_tracking_enabled

  • Type: Boolean
  • Défaut: false
Permet d'activer le tracking automatique Google Analytics (nécessite l'intégration du SDK Google Analytics) pour certains events.
⚠️ Nécessite une intégration classique du SDK Google Analytics, e.g utilisant la fonction ga().
Exemple
audit.config('ga_auto_tracking_enabled', false);

#gtm_auto_tracking_enabled

  • Type: Boolean
  • Défaut: false
Permet d'activer le tracking automatique vers Google Tag Manager (nécessite l'intégration du tag de GTM) pour certains events.
Les informations de chaque évènement sont envoyées directement dans le dataLayer sous la même forme qu'un event Google Analytics.
Exemple
audit.config('gtm_auto_tracking_enabled', false);

#gtag_auto_tracking_enabled

  • Type: Boolean
  • Défaut: false
Permet d'activer le tracking automatique Google Analytics 4 (nécessite l'intégration du tag Google Analytics 4) pour certains events.
⚠️ Nécessite une intégration de Google Analytics 4, i.e l'usage de la fonction gtag().
Exemple
audit.config('gtag_auto_tracking_enabled', false);

#auto_tracking_spec_v2

  • Type: Boolean
  • Défaut: false
Permet d'activer la nouvelle version de nos connecteurs (GA, GTM, Gtag, AT, Piano). Celle-ci est plus précise et permet un suivi des performances plus détaillé dans vos outils d'analyses.
⚠️ Cette option ne peut fonctionner seule, elle doit être accompagnée par l’une des options d’activation du tracking automatique GA, GTM, Gtag, AT ou Piano.
Exemple
audit.config('auto_tracking_spec_v2', true);

#ati_tag_options

  • Type: Object
  • Défaut: {}
Permet de passer des options de configuration au constructeur ATInternet.Tracker.Tag. Voir la documentation ATInternet pour plus d'informations.
Exemple
audit.config('ati_tag_options', { requestMethod: 'POST' });

#beacons

  • Type: Boolean
  • Défaut: true
Permet d'envoyer certains events en utilisant navigator.sendBeacon au lieu d'une simple requête XHR.
Example
audit.config('beacons', false);

#cookies_path

  • Type: String
  • Défaut: '/'
Permet de définir un chemin personnalisé pour les cookies déposés par Poool.
Example
audit.config('cookies_path', '/contenu-specifique');
arrow_forward
SuivantÉvènements Audit.js