Outbrain Pixel + S2S Postback — Dokumentation
Outbrain Pixel + S2S Postback fügt Ihrem PrestaShop-Shop Outbrain-Conversion-Tracking hinzu, mit Browser-Pixel-Events und optionalen Server-to-Server-Postbacks. Das Modul hilft Ihnen, E-Commerce- und Lead-Signale an Outbrain zu senden, während Event-Auswahl, Einwilligungsverwaltung und Diagnose im Back Office bleiben.
Funktionen
- Outbrain-Browser-Pixel. Das Modul bindet das Outbrain Pixel über
displayHeaderein und lädthttps://amplify.outbrain.com/cp/obtp.js, wenn Tracking aktiv ist. - E-Commerce-Event-Tracking. Es kann PageView-, View Content-, View Category-, Add To Cart-, Checkout-, Purchase-, Search-, Add To Wishlist- und Sign Up-Events senden.
- Purchase-Event bei der Bestellbestätigung. Der Hook
displayOrderConfirmationsendet das Browser-Purchase-Event mit Bestellwert, Währung, Bestell-ID und Produktdaten. - Server-to-Server-Postbacks. Geeignete Conversions können in eine Warteschlange gestellt und über
https://tr.outbrain.com/unifiedPixelan Outbrain gesendet werden, wenn eine Outbrain-Klick-ID verfügbar ist. - Erfassung der Klick-ID. Das Front-Script liest
ob_click_id,OutbrainClickId,outbrain_click_idunddicboaus Landing-URLs und speichert den Wert im Cookiemproutbr_ob_click_id. - Eigene Conversion-Regeln. Sie können JSON-Regeln für Conversions auf Basis von Klicks, URLs, Controllern oder DOM-Events definieren. Controller-Regeln können optional auf ausgewählte Modul-Front-Controller beschränkt werden.
- Front-Conversion-Bridge. Der Front-Controller
conversionempfängt token-geschützte Browser-Bridge-Events für die S2S-Warteschlange. - Registrierungs-Tracking. Der Hook
actionCustomerAccountAddmarkiert neue Kundenkonten, damit die nächste Kontoseite das Sign Up-Event senden kann. - Einwilligungsbewusstes Laden. Wenn
mprcookiesrevolutionodermprcookiebanneraktiv ist, wartet das Pixel vor dem Start auf die Marketing-Einwilligung. - Diagnose und Warteschlangensteuerung. Die Back-Office-Seite zeigt Bereitschaftsprüfungen, Warteschlangenzähler für ausstehende, sendende, gesendete und fehlgeschlagene Events, eine S2S-Testaktion und eine Wiederholungsaktion für fehlgeschlagene Events.
- Cron-Verarbeitung. Der Queue-Worker registriert
send_outbrain_conversionsmitschedule: every:300undtimeout: 30.
Konfigurationsoptionen
Legen Sie diese Werte unter Modules > Outbrain Pixel + S2S Postback > Configure fest.
- Outbrain Pixel aktivieren. Schaltet Browser-Tracking ein oder aus; Standard:
0. - Outbrain Marketer ID. Speichert Ihre numerische Outbrain Marketer ID; Standard: ``. Mehrere IDs können durch Kommas getrennt werden.
- Mitarbeiter ausschließen. Verhindert Tracking, wenn ein angemeldeter Back-Office-Mitarbeiter das Front Office aufruft; Standard:
1. - Cookie-Einwilligung beachten. Wartet auf die Marketing-Einwilligung von
mprcookiesrevolutionodermprcookiebanner, wenn eines der Module aktiv ist; Standard:1. - PageView verfolgen. Sendet das Outbrain-Event
PAGE_VIEWaus dem Seiten-Header; Standard:1. - View Content verfolgen. Sendet Produktansicht-Events auf Produktseiten; Standard:
1. - View Category verfolgen. Sendet Kategorieansicht-Events, wenn eine aktuelle Kategorie erkannt wird; Standard:
1. - Add To Cart verfolgen. Sendet Warenkorb-Events über den PrestaShop-Event-Bus oder unterstützte Warenkorb-Buttons; Standard:
1. - Checkout verfolgen. Sendet Checkout-Start-Events, wenn das Modul die Startseite des checkout mit Produkten im Warenkorb erkennt; Standard:
1. - Purchase verfolgen. Sendet Purchase-Events bei der Bestellbestätigung und kann Purchase-Postbacks für S2S in die Warteschlange stellen; Standard:
1. - Search verfolgen. Sendet Such-Events im Such-Controller, wenn
sodersearch_queryvorhanden ist; Standard:1. - Add To Wishlist verfolgen. Sendet Wunschlisten-Events über unterstützte Wunschlisten-Buttons und den PrestaShop-Wunschlisten-Event-Bus; Standard:
1. - Sign Up verfolgen. Sendet ein Sign Up-Event nach der Erstellung eines Kundenkontos; Standard:
1. - Name des Purchase-Events. Steuert den Outbrain-Eventnamen für Käufe; Standard:
Purchase. - Eigene Events verfolgen. Aktiviert über JSON definierte eigene Conversion-Regeln; Standard:
0. - Eigene Event-Regeln. Speichert das JSON-Array für eigene Regeln auf Basis von Klicks, URLs, Controllern oder DOM-Events; Standard: ``.
- S2S-Postback-Events aktivieren. Stellt geeignete Conversion-Events serverseitig in die Warteschlange, wenn eine Outbrain-Klick-ID verfügbar ist; Standard:
0. - Test ob_click_id. Speichert eine echte Outbrain-Klick-ID, die nur vom administrativen S2S-Test verwendet wird; Standard: ``.
- IP und User-Agent in Warteschlangen-Metadaten behalten. Behält IP- und User-Agent-Metadaten in der gemeinsamen Conversion-Warteschlange für Diagnosezwecke; Standard:
1. - Batch-Limit der Warteschlange. Legt fest, wie viele Conversion-Events der Cron-Prozessor pro Lauf verarbeitet; Standard:
20. Zulässiger Bereich:1-1000.
Anpassungsbeispiele
Kampagnen-Landing-URL mit Erfassung der Outbrain-Klick-ID:
https://www.example.com/product.html?ob_click_id={{ob_click_id}}
Mehrere Marketer IDs können so eingegeben werden:
123456, 789012
Klickbasierte eigene Event-Regel für Interaktion mit der Produktgalerie:
[
{
"event": "Gallery Browse",
"trigger": "click",
"selector": ".product-images img,.images-container img",
"params": {
"property": "product_gallery"
},
"s2s": true
}
]
Lead-Button mit zusätzlichen Outbrain-Parametern aus HTML-Attributen:
<a
href="/contact"
class="js-outbrain-lead"
data-outbrain-param-property="contact_cta"
data-outbrain-param-placement="product_page"
>
Contact us
</a>
Passende Regel für diesen Button:
[
{
"event": "Lead",
"trigger": "click",
"selector": ".js-outbrain-lead",
"s2s": true
}
]
URL-basiertes Lead-Event für die Kontaktseite:
[
{
"event": "Lead",
"trigger": "url",
"contains": ["/contact"],
"params": {
"property": "contact_page"
},
"s2s": true
}
]
Controller-basierte Regel mit optionaler Modul-Zuordnung für Modul-Front-Controller:
[
{
"event": "Lead",
"trigger": "controller",
"controllers": ["contact"],
"modules": [],
"params": {
"property": "contact_controller"
},
"once": true,
"s2s": true
}
]
DOM-Event-Regel für ein eigenes Formular oder Theme-Script:
[
{
"event": "Lead",
"trigger": "event",
"dom_event": "mproutbr:lead",
"params": {
"property": "custom_form"
},
"s2s": true
}
]
Theme-JavaScript, das das DOM-Event auslöst:
document.dispatchEvent(new CustomEvent('mproutbr:lead', {
detail: {
params: {
placement: 'footer_form',
value: 1
}
}
}));
Direkter Browser-Tracking-Aufruf, nachdem das Modul gestartet wurde:
if (typeof window.mproutbrTrack === 'function') {
window.mproutbrTrack('Lead', {
property: 'custom_cta',
event_source_url: window.location.href
}, true);
}
Installation
- Laden Sie die ZIP-Datei des Moduls aus Ihrem mypresta.rocks-Konto herunter.
- Gehen Sie im PrestaShop-Back-Office zu Modules > Module Manager.
- Klicken Sie auf Upload a module und wählen Sie die ZIP-Datei aus.
- Öffnen Sie nach der Installation Modules > Outbrain Pixel + S2S Postback > Configure.
- Speichern Sie die erforderlichen Werte und nutzen Sie anschließend das Diagnose-Panel, um den Pixel-Status, die Klick-ID-Bereitschaft und den Warteschlangenstatus zu prüfen.
- Wenn Sie S2S-Postbacks verwenden, fügen Sie Kampagnen-URLs einen Outbrain-Klick-ID-Parameter hinzu und testen Sie mit Send S2S probe anhand einer echten
ob_click_id.
Funktionsweise
Im Storefront sehen Käufer durch dieses Modul kein Widget und keinen Banner. Wenn Tracking aktiv ist, lädt das Modul das Outbrain Pixel im Seiten-Header, sendet ausgewählte Browser-Events und erfasst Outbrain-Klick-IDs aus Kampagnen-Landing-URLs.
Für Käufe und geeignete eigene Events kann das Modul außerdem serverseitige Postbacks in eine Warteschlange stellen. Der Cron-Task verarbeitet diese Warteschlange in Batches, und das Diagnose-Panel zeigt, ob Events ausstehend sind, gerade gesendet wurden, gesendet sind oder fehlgeschlagen sind.
Ehrliche Grenzen
- S2S-Attribution erfordert eine echte Outbrain-Klick-ID im Besuch; Browser-Pixel-Tracking kann ohne sie laufen, aber Postbacks ohne Klick-ID werden nicht in die Warteschlange gestellt.
- PageView ist in diesem Modul nur browserseitig und wird nicht über die S2S-Bridge gesendet.
- Der S2S-Test benötigt eine echte
ob_click_idaus einem Outbrain-Anzeigenklick, keinen frei erfundenen Testwert. - Das Warten auf Einwilligung gilt nur, wenn
mprcookiesrevolutionodermprcookiebanneraktiv ist und das Einwilligungs-Cookie/-Event verfügbar ist. - Add To Cart- und Add To Wishlist-Tracking unterstützt gängige PrestaShop-Event-Busse und Selektoren; ungewöhnliche eigene Themes können eine eigene Event-Regel benötigen.
- Kampagneneinrichtung, Conversion-Benennung und Reporting innerhalb von Outbrain werden weiterhin in Ihrem Outbrain-Konto verwaltet.
Kompatibilität: PrestaShop 1.6 bis 9.0 (neueste Version), PHP 7.1+. Wir unterstützen auch kommende PrestaShop-Versionen weiterhin.