Poool
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.

#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.

#mode

  • Type: String
  • Valeurs acceptées: 'hide', 'excerpt', 'custom'
  • Défaut: 'hide'
La méthode utilisée par Poool pour bloquer votre contenu premium.
Modes disponibles :
  • hide: Le contenu original reste là où il est, mais le css du parent sera modifié pour cacher une partie du texte. Inconvénients : Les utilisateurs peuvent ouvrir la console du navigateur et supprimer les styles appliqués au parent.
  • excerpt: Le contenu original est placé dans un view holder, et le contenu de son parent sera remplacé par le contenu coupé (seulement X% du texte seront gardés). Le contenu original n'est pas disponible en dehors du scope de Poool (même depuis la console), et sera remis en place quand l'évenement onRelease sera appelé. Inconvénients : les balises <style> et <script> sont retirées temporairement et placées à la fin du texte coupé. Si des balises <script> sont présentes dans vos contenus, celles-ci peuvent ne pas être exécutées et pourront également entraîner des erreurs javascript (certains scripts de publicité utilisent par exemple des fonctions javascript obsolètes), amenant à une page blanche lors du déblocage de l'article. Ce mode est également déconseillé pour les applications one-page (Angular, React, Vue, ...). Dans ces deux cas précis, nous vous conseillons d'utiliser le mode hide.
  • custom:Aucune modification ne sera faite sur votre contenu et/ou son parent, mais les évenements onLock et onRelease seront appelés pour que vous puissiez utiliser vos propres méthodes d'obfuscation.

#percent

  • Type: Number
  • Défaut: 80
Pourcentage de texte que vous souhaitez cacher.

#post_container

  • Type: String
  • Défaut: '[data-poool]'
Sélecteur CSS ciblant l'élement dans lequel se trouve le contenu de l'article à bloquer.

#widget_container

  • Type: String
  • Défaut: '#poool-widget'
Sélecteur CSS ciblant l'élement dans lequel se placera le widget Poool.

#app_name

  • Type: String
  • Défaut: ''
Utilisé pour afficher le nom du journal dans certains widgets. Cette valeur peut être écrasée par les valeurs du Dashboard.

#force_widget

  • Type: String
  • Valeurs acceptées: 'auto', 'hidden', 'disabled', 'none', 'video', 'newsletter', 'subscription', 'gift', 'restriction', 'question', 'unlock', 'link', 'pass', 'unlock', 'invisible'
  • Défaut: 'auto'
Écrase le comportement par défaut du paywall et force un type de widget (le type de widget affiché par défaut est déterminé par le comportement de l'utilisateur).

#subscription_url

  • Type: String
  • Défaut: null
L'URL de votre page d'abonnement. Le widget abonnement redirigera l'utilisateur s'il souhaite s'abonner.
La variable {return_url} peut être utilisée pour récupérer l'url en cours.
La variable {user_id} peut être utilisée pour récupérer l'identifiant Poool du lecteur.

#subscription_button_enabled

  • Type: Boolean
  • Défaut: true
Affiche/cache le bouton d'abonnement sur tous les widgets (sauf “Abonnement” et “Déblocage invisible”).

#newsletter_name

  • Type: String
  • Défaut: null
Nom de la newsletter associée à l'enregistrement de l'email de l'utilisateur sur le widget newsletter.

#newsletter_id

  • Type: String
  • Défaut: null
Identifiant de la newsletter associée à l'enregistrement de l'email de l'utilisateur sur le widget newsletter.
Peut ensuite être utilisé avec l'API Poool pour connaître les newsletter auxquelles un utilisateur s'est inscrit.

#login_url

  • Type: String
  • Défaut: null
Your login page url. A user will be redirected here after clicking on the login button.
{return_url} variable can be used to get the current URL.
{user_id} variable can be used to get the reader's Poool id.

#login_button_enabled

  • Type: Boolean
  • Défaut: true
Affiche/cache le bouton de connexion sur tous les widgets.

#signature_enabled

  • Type: Boolean
  • Défaut: true
Affiche/cache le texte de signature apparaissant en bas de l'article après déblocage.

#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 pas utilisée pour débloquer le paywall automatiquement, elle est uniquement utilisée à des fins statistiques.

#video_client

  • Type: String
  • Valeurs acceptées: 'vast', 'googima'
  • Défaut: 'vast'
Permet de définir le client par défaut du player pour le widget video.

#popover_enabled

  • Type: Boolean
  • Défaut: true
Active/désactive la popover affichée quand le paywall n'est pas encore dans la vue.

#alternative_enabled

  • Type: Boolean
  • Défaut: true
Affiche/cache le lien 'Non Merci' de certains widgets.

#alternative_widget

  • Type: String
  • Valeurs acceptées: 'none', 'gift', 'video', 'question', 'restriction', 'newsletter'
  • Défaut: 'none'
Modifie l'action alternative de certains widgets.

#vast

  • Type: String
  • Défaut: null
URL nécessaire à l'affichage de publicités vidéos dans le widget vidéo sur desktop.

#mobile_vast

  • Type: String
  • Défaut: null
URL nécessaire à l'affichage de publicités vidéos dans le widget vidéo sur mobile.

#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.

#custom_segment

  • Type: String
  • Défaut: null
Permet d'attribuer à un lecteur un groupe personnalisé défini au préalable dans le Dashboard.

#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.

#consent_rejection_widget

  • Type: String
  • Valeurs acceptées: 'invisible', 'unlock', 'gift', 'subscription'
  • Défaut: 'subscription'
Permet de définir l'action à afficher par défaut si l'option de configuration {cookies_enabled} est false (refus de consentement à la dépose de cookies).

#data_policy_url

  • Type: String
  • Défaut: null
URL du lien affiché dans les widgets nécessitant la collecte d'informations sur l'utilisateur.
La variable {return_url} peut être utilisée pour récupérer l'url en cours.
La variable {user_id} peut être utilisée pour récupérer l'identifiant Poool du lecteur.

#locale

  • Type: String
  • Valeurs acceptées: 'fr', 'en'
  • Défaut: 'fr'
Langue d'affichage du paywall.

#popover_timeout

  • Type: Number
  • Défaut: 5000
Temps d'affichage de la popover (en millisecondes).
Si la valeur renseignée est -1, la popover restera affichée.

#disable_content_height_calculation

  • Type: Boolean
  • Défaut: false
Quand le mode de masquage hide est utilisé et après déblocage d'un article, le paywall tentera de calculer la hauteur du contenu pour la remettre à sa valeur d'origine.
Dans certains cas très rares, la taille du contenu de l'article tronqué changera entre le moment où il est tronqué, et le moment ou il est débloqué (chargement de modules twitter, chargement de gifs, etc...).
Si disable_content_height_calculation est à true, le paywall ne tentera pas de calculer la hauteur du contenu et enlèvera simplement les modifications css qu'il a appliquées au conteneur de l'article.

#wait_for_dom_load

  • Type: Boolean
  • Défaut: false
Par défaut, pour éviter des temps de chargement trop longs sur certains medias, le paywall Poool n'attendra pas le chargement de la page pour s'afficher.
Dans certains cas, il est nécessaire d'attendre le chargement complet du DOM pour que le paywall Poool soit capable de détecter le contenu de l'article à bloquer.
Si wait_for_dom_load est à true, le paywall attendra que l'évènement DOMContentLoaded soit déclenché pour s'afficher.

#dom_load_timeout

  • Type: Number
  • Défaut: 2000
Permet de définir le temps d'attente par défaut du paywall pour l'évènement DOMContentLoaded de la page si wait_for_dom_load est à true.

#paywall_load_timeout

  • Type: Number
  • Défaut: 10000
Permet de définir le temps d'attente par défaut pour l'affichage complet du Paywall. Passé ce délai, l'évènement onError est déclenché pour que vous puissiez afficher un paywall de secours.

#track_original_action

  • Type: Boolean
  • Défaut: false
Permet d'effectuer le tracking des articles débloqués sur les actions d'origine plutôt que les alternatives.
Quand un article est débloqué avec une alternative (par exemple si force_widget est utilisé ou si l'utilisateur clique sur Non, merci), les statistiques remonteront par défaut un déblocage avec cette action alternative plutôt que l'action d'origine.

#components_load_timeout

  • Type: Number
  • Défaut: 5000
Permet de définir le temps d'attente par défaut pour le chargement complet des différents composants du paywall. Passé ce délai, l'évènement onError est déclenché pour que vous puissiez afficher un paywall de secours.

#ati_tracking_enabled

  • Type: Boolean
  • Défaut: false
Permet d'activer le tracking AT Internet (nécessite l'intégration du SDK AT Internet).
⚠️ Déprécié : remplacé par ati_auto_tracking_enabled.

#ati_load_timeout

  • Type: Number
  • Défaut: 2000
Permet de définir le temps d'attente par défaut pour le déclenchement de l'évènement de tracking AT Internet. Passé ce délai, le paywall est chargé avec la méthode habituelle, et le tracking Poool vers AT Internet est désactivé.

#facebook_login_enabled

  • Type: Boolean
  • Défaut: false
Active/désactive le bouton de connexion Facebook dans le paywall. Afin de pouvoir utiliser la connexion avec Facebook, vous devez effectuer un appel au SDK de connexion Facebook au déclenchement de l'évènement onFacebookLoginClick.

#google_login_enabled

  • Type: Boolean
  • Défaut: false
Active/désactive le bouton de connexion Google dans le paywall. Afin de pouvoir utiliser la connexion avec Google, vous devez effectuer un appel au SDK de connexion Google au déclenchement de l'évènement onGoogleLoginClick.

#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.

#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().

#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.

#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().

#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.

#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.

#custom_reader_id

  • Type: String
  • Défaut: null
Permet d'assigner votre propre identifiant unique d'utilisateur à l'un de vos lecteurs.

#stripe_public_key

  • Type: String
  • Défaut: null
Permet d'activer le champ carte bancaire Stripe dans les formulaires du paywall.

#popover_auto_hide

  • Type: Boolean
  • Défaut: true
Lors du scroll, si le widget apparait à l'écran, la popover disparait automatiquement (événement onWidgetSeen).
Configurer popover_auto_hide à false permet de désactiver ce comportement.

#custom_return_url

  • Type: String
  • Défaut: null
Lorsqu'un lecteur quitte l'article via un élément du paywall (click sur les liens "Je me connecte", "Je m'abonne" ou sur l'action principale du widget Découverte URL), le paramètre return_url est placé dans l'url. Il s'agit par défaut de l'url en cours.
Configurer custom_return_url permet de définir une url de retour personnalisée.

#cookies_domain

  • Type: String
  • Défaut: null
Permet de définir un domaine personnalisé pour les cookies déposés par Poool.

#default_widget

  • Type: String
  • Valeurs acceptées: 'invisible', 'unlock', 'gift', 'subscription'
  • Défaut: 'subscription'
Permet de définir un widget à afficher en cas d'erreur réseau.
Il est ainsi possible d'opter pour un déblocage manuel (ex: gift, etc..) ou bien un déblocage automatique avec le widget invisible.
Voir le guide Handle timeouts & errors pour plus d'informations.

#fallback_widget

  • Type: String
  • Défaut: 'subscription'
Permet de définir un widget de repli à afficher en cas d'erreur sur les widgets publicitaires (video, viewpay).
Préférez configurer cette option directement dans votre dashboard (édition du widget), surtout si votre widget de repli nécessite de la donnée (ex: widgets question ou form).

#audit_load_timeout

  • Type: Number
  • Défaut: 2000
Dans le cas d'une intégration complète avec Audit et Access, le paramètre audit_load_timeout permet de définir le temps d'attente (en millisecondes) de la réponse d'Audit.
Si le temps est dépassé, Access se chargera directement d'afficher votre paywall. Concernant la segmentation native, il est dans ce cas possible que le lecteur ne soit pas correctement mis à jour.
arrow_forward
SuivantÉcouter des évènements