Outbrain Pixel + S2S Postback — Documentación

Outbrain Pixel + S2S Postback añade el seguimiento de conversiones de Outbrain a su tienda PrestaShop, con eventos Pixel en el navegador y postbacks server-to-server opcionales. El módulo le ayuda a enviar señales de e-commerce y leads a Outbrain, manteniendo la selección de eventos, la gestión del consentimiento y los diagnósticos dentro del back office.

Funciones

• Outbrain Pixel en el navegador. El módulo inserta Outbrain Pixel desde displayHeader y carga https://amplify.outbrain.com/cp/obtp.js cuando el seguimiento está activo.
• Seguimiento de eventos e-commerce. Puede enviar eventos PageView, View Content, View Category, Add To Cart, Checkout, Purchase, Search, Add To Wishlist y Sign Up.
• Evento de compra en la confirmación del pedido. El hook displayOrderConfirmation envía el evento de compra del navegador con el valor del pedido, la moneda, el ID del pedido y los datos de producto.
• Postbacks server-to-server. Las conversiones aptas pueden ponerse en cola y enviarse a Outbrain mediante https://tr.outbrain.com/unifiedPixel cuando hay disponible un ID de clic de Outbrain.
• Captura del ID de clic. El script front lee ob_click_id, OutbrainClickId, outbrain_click_id y dicbo desde las URL de destino y guarda el valor en la cookie mproutbr_ob_click_id.
• Reglas de conversión personalizadas. Puede definir reglas JSON para conversiones basadas en clic, URL, controlador o evento DOM. Las reglas de controlador pueden limitarse opcionalmente a front controllers de módulo seleccionados.
• Puente de conversión front. El front controller conversion recibe eventos de puente del navegador protegidos por token para ponerlos en la cola S2S.
• Seguimiento de registro. El hook actionCustomerAccountAdd marca las nuevas cuentas de cliente para que la siguiente página de cuenta pueda enviar el evento Sign Up.
• Carga respetuosa con el consentimiento. Cuando mprcookiesrevolution o mprcookiebanner está activo, el Pixel espera el consentimiento de marketing antes de arrancar.
• Diagnósticos y controles de cola. La página del back office muestra comprobaciones de disponibilidad, contadores de cola para eventos pendientes/en envío/enviados/fallidos, una acción de prueba S2S y una acción de reintento para eventos fallidos.
• Procesamiento cron. El worker de cola registra send_outbrain_conversions con schedule: every:300 y timeout: 30.

Opciones de configuración

Configure estos valores en Modules > Outbrain Pixel + S2S Postback > Configure.

• Activar Outbrain Pixel. Activa o desactiva el seguimiento en el navegador; predeterminado: 0.
• Outbrain Marketer ID. Guarda su Outbrain Marketer ID numérico; predeterminado: ``. Varios IDs pueden separarse con comas.
• Excluir empleados. Detiene el seguimiento cuando un empleado conectado al back office navega por el front office; predeterminado: 1.
• Respetar el consentimiento de cookies. Espera el consentimiento de marketing de mprcookiesrevolution o mprcookiebanner cuando alguno de los módulos está activo; predeterminado: 1.
• Seguir PageView. Envía el evento Outbrain PAGE_VIEW desde la cabecera de la página; predeterminado: 1.
• Seguir View Content. Envía eventos de vista de producto en páginas de producto; predeterminado: 1.
• Seguir View Category. Envía eventos de vista de categoría cuando se detecta una categoría actual; predeterminado: 1.
• Seguir Add To Cart. Envía eventos de añadir al carrito desde el bus de eventos de PrestaShop o desde botones de añadir al carrito compatibles; predeterminado: 1.
• Seguir Checkout. Envía eventos de inicio de checkout cuando el módulo detecta la página de inicio del checkout con productos en el carrito; predeterminado: 1.
• Seguir Purchase. Envía eventos de compra en la confirmación del pedido y puede poner en cola postbacks de compra para S2S; predeterminado: 1.
• Seguir Search. Envía eventos de búsqueda en el controlador de búsqueda cuando s o search_query está presente; predeterminado: 1.
• Seguir Add To Wishlist. Envía eventos de lista de deseos desde botones de lista de deseos compatibles y el bus de eventos de lista de deseos de PrestaShop; predeterminado: 1.
• Seguir Sign Up. Envía un evento Sign Up después de crear una cuenta de cliente; predeterminado: 1.
• Nombre del evento Purchase. Controla el nombre de evento de Outbrain utilizado para compras; predeterminado: Purchase.
• Seguir eventos personalizados. Activa reglas de conversión personalizadas definidas en JSON; predeterminado: 0.
• Reglas de eventos personalizados. Guarda el array JSON para reglas personalizadas basadas en clic, URL, controlador o evento DOM; predeterminado: ``.
• Activar eventos de postback S2S. Pone en cola del lado servidor los eventos de conversión aptos cuando hay disponible un ID de clic de Outbrain; predeterminado: 0.
• Test ob_click_id. Guarda un ID de clic real de Outbrain usado solo por la prueba S2S del administrador; predeterminado: ``.
• Mantener IP y user agent en los metadatos en cola. Conserva metadatos de IP y user-agent en la cola de conversión compartida para diagnósticos; predeterminado: 1.
• Límite de lote de cola. Define cuántos eventos de conversión en cola gestiona el procesador cron por ejecución; predeterminado: 20. Rango permitido: 1-1000.

Ejemplos de personalización

URL de destino de campaña con captura del ID de clic de Outbrain:

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

Varios Marketer IDs pueden introducirse así:

123456, 789012

Regla de evento personalizado basada en clic para interacción con la galería de producto:

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

Botón lead con parámetros adicionales de Outbrain leídos desde atributos HTML:

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

Regla correspondiente para ese botón:

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

Evento lead basado en URL para la página de contacto:

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

Regla basada en controlador, con coincidencia opcional de módulo para front controllers de módulo:

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

Regla de evento DOM para un formulario personalizado o script del tema:

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

JavaScript del tema que dispara el evento DOM:

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

Llamada directa de seguimiento en el navegador después de que el módulo haya arrancado:

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

Instalación

1. Descargue el ZIP del módulo desde su cuenta de mypresta.rocks.
2. En el back office de PrestaShop, vaya a Modules > Module Manager.
3. Haga clic en Upload a module y seleccione el archivo ZIP.
4. Después de la instalación, abra Modules > Outbrain Pixel + S2S Postback > Configure.
5. Guarde los valores requeridos y use el panel de diagnósticos para confirmar el estado del Pixel, la disponibilidad del ID de clic y el estado de la cola.
6. Si usa postbacks S2S, añada un parámetro de ID de clic de Outbrain a las URL de campaña y pruebe con Send S2S probe usando un ob_click_id real.

Cómo funciona

En la tienda, los compradores no ven ningún widget ni banner de este módulo. Cuando el seguimiento está activo, el módulo carga Outbrain Pixel en la cabecera de la página, envía los eventos de navegador seleccionados y captura IDs de clic de Outbrain desde las URL de destino de las campañas.

Para compras y eventos personalizados aptos, el módulo también puede poner en cola postbacks del lado servidor. La tarea cron procesa esa cola por lotes y el panel de diagnósticos muestra si los eventos están pendientes, en envío, enviados o fallidos.

Límites claros

• La atribución S2S requiere un ID de clic real de Outbrain en la visita; el seguimiento Pixel en el navegador puede ejecutarse sin él, pero los postbacks sin ID de clic no se ponen en cola.
• PageView en este módulo es solo de navegador y no se envía a través del puente S2S.
• La prueba S2S necesita un ob_click_id real de un clic en un anuncio de Outbrain, no un valor de prueba inventado.
• La espera de consentimiento solo se aplica cuando mprcookiesrevolution o mprcookiebanner está activo y la cookie/el evento de consentimiento está disponible.
• El seguimiento Add To Cart y Add To Wishlist admite buses de eventos y selectores comunes de PrestaShop; los temas personalizados poco habituales pueden necesitar una regla de evento personalizada.
• La configuración de campañas Outbrain, los nombres de conversión y los informes dentro de Outbrain siguen gestionándose en su cuenta de Outbrain.

Compatibilidad: PrestaShop 1.6 a 9.0 (última versión), PHP 7.1+. Seguimos dando soporte a las próximas versiones de PrestaShop.