Outbrain Pixel + S2S Postback — Documentation

Outbrain Pixel + S2S Postback ajoute le suivi des conversions Outbrain à votre boutique PrestaShop, avec des événements Pixel côté navigateur et des postbacks server-to-server optionnels. Le module vous aide à envoyer des signaux e-commerce et de leads à Outbrain, tout en gardant la sélection des événements, la gestion du consentement et les diagnostics dans le back-office.

Fonctionnalités

• Pixel navigateur Outbrain. Le module injecte le Pixel Outbrain depuis displayHeader et charge https://amplify.outbrain.com/cp/obtp.js lorsque le suivi est actif.
• Suivi des événements e-commerce. Il peut envoyer les événements PageView, View Content, View Category, Add To Cart, Checkout, Purchase, Search, Add To Wishlist et Sign Up.
• Événement d’achat sur la confirmation de commande. Le hook displayOrderConfirmation envoie l’événement d’achat côté navigateur avec le montant de la commande, la devise, l’ID de commande et les données produit.
• Postbacks server-to-server. Les conversions éligibles peuvent être mises en file d’attente et envoyées à Outbrain via https://tr.outbrain.com/unifiedPixel lorsqu’un ID de clic Outbrain est disponible.
• Capture de l’ID de clic. Le script front lit ob_click_id, OutbrainClickId, outbrain_click_id et dicbo depuis les URL d’atterrissage et stocke la valeur dans le cookie mproutbr_ob_click_id.
• Règles de conversion personnalisées. Vous pouvez définir des règles JSON pour des conversions basées sur un clic, une URL, un contrôleur ou un événement DOM. Les règles de contrôleur peuvent éventuellement être limitées à certains front controllers de module.
• Pont de conversion front. Le front controller conversion reçoit des événements de pont navigateur protégés par token pour la mise en file d’attente S2S.
• Suivi des inscriptions. Le hook actionCustomerAccountAdd marque les nouveaux comptes client afin que la prochaine page de compte puisse envoyer l’événement Sign Up.
• Chargement respectueux du consentement. Lorsque mprcookiesrevolution ou mprcookiebanner est actif, le Pixel attend le consentement marketing avant de démarrer.
• Diagnostics et contrôles de file d’attente. La page du back-office affiche les vérifications de disponibilité, les compteurs de file pour les événements en attente/en cours d’envoi/envoyés/échoués, une action de test S2S et une action de nouvelle tentative pour les événements échoués.
• Traitement cron. Le worker de file d’attente enregistre send_outbrain_conversions avec schedule: every:300 et timeout: 30.

Options de configuration

Définissez ces valeurs dans Modules > Outbrain Pixel + S2S Postback > Configure.

• Activer Outbrain Pixel. Active ou désactive le suivi côté navigateur ; valeur par défaut : 0.
• Outbrain Marketer ID. Enregistre votre Outbrain Marketer ID numérique ; valeur par défaut : ``. Plusieurs IDs peuvent être séparés par des virgules.
• Exclure les employés. Empêche le suivi lorsqu’un employé connecté au back-office parcourt le front-office ; valeur par défaut : 1.
• Respecter le consentement aux cookies. Attend le consentement marketing de mprcookiesrevolution ou mprcookiebanner lorsque l’un de ces modules est actif ; valeur par défaut : 1.
• Suivre PageView. Envoie l’événement Outbrain PAGE_VIEW depuis l’en-tête de page ; valeur par défaut : 1.
• Suivre View Content. Envoie les événements de vue produit sur les pages produit ; valeur par défaut : 1.
• Suivre View Category. Envoie les événements de vue catégorie lorsqu’une catégorie courante est détectée ; valeur par défaut : 1.
• Suivre Add To Cart. Envoie les événements d’ajout au panier depuis le bus d’événements PrestaShop ou les boutons d’ajout au panier pris en charge ; valeur par défaut : 1.
• Suivre Checkout. Envoie les événements de début de checkout lorsque le module détecte la page de démarrage du checkout avec des produits dans le panier ; valeur par défaut : 1.
• Suivre Purchase. Envoie les événements d’achat sur la confirmation de commande et peut mettre en file les postbacks d’achat pour le S2S ; valeur par défaut : 1.
• Suivre Search. Envoie les événements de recherche sur le contrôleur de recherche lorsque s ou search_query est présent ; valeur par défaut : 1.
• Suivre Add To Wishlist. Envoie les événements de liste d’envies depuis les boutons de liste d’envies pris en charge et le bus d’événements de liste d’envies PrestaShop ; valeur par défaut : 1.
• Suivre Sign Up. Envoie un événement Sign Up après la création d’un compte client ; valeur par défaut : 1.
• Nom de l’événement Purchase. Contrôle le nom d’événement Outbrain utilisé pour les achats ; valeur par défaut : Purchase.
• Suivre les événements personnalisés. Active les règles de conversion personnalisées définies en JSON ; valeur par défaut : 0.
• Règles d’événements personnalisés. Enregistre le tableau JSON des règles personnalisées basées sur un clic, une URL, un contrôleur ou un événement DOM ; valeur par défaut : ``.
• Activer les événements de postback S2S. Met en file côté serveur les événements de conversion éligibles lorsqu’un ID de clic Outbrain est disponible ; valeur par défaut : 0.
• Test ob_click_id. Enregistre un véritable ID de clic Outbrain utilisé uniquement par le test S2S administrateur ; valeur par défaut : ``.
• Conserver l’IP et l’user agent dans les métadonnées en file. Conserve les métadonnées IP et user-agent dans la file de conversion partagée pour les diagnostics ; valeur par défaut : 1.
• Limite de lot de la file d’attente. Définit le nombre d’événements de conversion en file traités par le processeur cron à chaque exécution ; valeur par défaut : 20. Plage autorisée : 1-1000.

Exemples de personnalisation

URL d’atterrissage de campagne avec capture de l’ID de clic Outbrain :

https://www.example.com/product.html?ob_click_id={{ob_click_id}}

Plusieurs Marketer IDs peuvent être saisis comme ceci :

123456, 789012

Règle d’événement personnalisé basée sur un clic pour l’interaction avec la galerie produit :

[
  {
    "event": "Gallery Browse",
    "trigger": "click",
    "selector": ".product-images img,.images-container img",
    "params": {
      "property": "product_gallery"
    },
    "s2s": true
  }
]

Bouton lead avec paramètres Outbrain supplémentaires lus depuis les attributs HTML :

<a
  href="/contact"
  class="js-outbrain-lead"
  data-outbrain-param-property="contact_cta"
  data-outbrain-param-placement="product_page"
>
  Contact us
</a>

Règle correspondante pour ce bouton :

[
  {
    "event": "Lead",
    "trigger": "click",
    "selector": ".js-outbrain-lead",
    "s2s": true
  }
]

Événement lead basé sur une URL pour la page de contact :

[
  {
    "event": "Lead",
    "trigger": "url",
    "contains": ["/contact"],
    "params": {
      "property": "contact_page"
    },
    "s2s": true
  }
]

Règle basée sur un contrôleur, avec correspondance de module optionnelle pour les front controllers de module :

[
  {
    "event": "Lead",
    "trigger": "controller",
    "controllers": ["contact"],
    "modules": [],
    "params": {
      "property": "contact_controller"
    },
    "once": true,
    "s2s": true
  }
]

Règle d’événement DOM pour un formulaire personnalisé ou un script de thème :

[
  {
    "event": "Lead",
    "trigger": "event",
    "dom_event": "mproutbr:lead",
    "params": {
      "property": "custom_form"
    },
    "s2s": true
  }
]

JavaScript du thème qui déclenche l’événement DOM :

document.dispatchEvent(new CustomEvent('mproutbr:lead', {
  detail: {
    params: {
      placement: 'footer_form',
      value: 1
    }
  }
}));

Appel direct de suivi navigateur après le démarrage du module :

if (typeof window.mproutbrTrack === 'function') {
  window.mproutbrTrack('Lead', {
    property: 'custom_cta',
    event_source_url: window.location.href
  }, true);
}

Installation

1. Téléchargez le fichier ZIP du module depuis votre compte mypresta.rocks.
2. Dans le back-office PrestaShop, allez dans Modules > Module Manager.
3. Cliquez sur Upload a module et sélectionnez le fichier ZIP.
4. Après l’installation, ouvrez Modules > Outbrain Pixel + S2S Postback > Configure.
5. Enregistrez les valeurs requises, puis utilisez le panneau de diagnostics pour confirmer l’état du Pixel, la disponibilité de l’ID de clic et l’état de la file d’attente.
6. Si vous utilisez les postbacks S2S, ajoutez un paramètre d’ID de clic Outbrain aux URL de campagne et testez avec Send S2S probe en utilisant un véritable ob_click_id.

Fonctionnement

Sur la boutique, les acheteurs ne voient aucun widget ni bannière provenant de ce module. Lorsque le suivi est actif, le module charge le Pixel Outbrain dans l’en-tête de page, envoie les événements navigateur sélectionnés et capture les IDs de clic Outbrain depuis les URL d’atterrissage des campagnes.

Pour les achats et les événements personnalisés éligibles, le module peut également mettre en file des postbacks côté serveur. La tâche cron traite cette file par lots, et le panneau de diagnostics indique si les événements sont en attente, en cours d’envoi, envoyés ou échoués.

Limites à connaître

• L’attribution S2S nécessite un véritable ID de clic Outbrain pendant la visite ; le suivi Pixel côté navigateur peut fonctionner sans lui, mais les postbacks sans ID de clic ne sont pas mis en file d’attente.
• PageView est uniquement côté navigateur dans ce module et n’est pas envoyé via le pont S2S.
• Le test S2S nécessite un véritable ob_click_id provenant d’un clic sur une annonce Outbrain, pas une valeur de test inventée.
• L’attente du consentement ne s’applique que lorsque mprcookiesrevolution ou mprcookiebanner est actif et que le cookie/l’événement de consentement est disponible.
• Le suivi Add To Cart et Add To Wishlist prend en charge les bus d’événements et sélecteurs PrestaShop courants ; les thèmes personnalisés atypiques peuvent nécessiter une règle d’événement personnalisée.
• La configuration des campagnes Outbrain, le nommage des conversions et les rapports dans Outbrain restent gérés depuis votre compte Outbrain.

Compatibilité : PrestaShop 1.6 à 9.0 (dernière version), PHP 7.1+. Nous continuons à prendre en charge les prochaines versions de PrestaShop.