Outbrain Pixel + S2S Postback — Dokumentacja
Outbrain Pixel + S2S Postback dodaje śledzenie konwersji Outbrain do sklepu PrestaShop, z eventami Pixel w przeglądarce oraz opcjonalnymi postbackami server-to-server. Moduł pomaga wysyłać do Outbrain sygnały e-commerce i leadowe, a wybór eventów, obsługa zgód oraz diagnostyka pozostają w back office.
Funkcje
- Outbrain Pixel w przeglądarce. Moduł wstrzykuje Outbrain Pixel z
displayHeaderi ładujehttps://amplify.outbrain.com/cp/obtp.js, gdy śledzenie jest aktywne. - Śledzenie eventów e-commerce. Może wysyłać eventy PageView, View Content, View Category, Add To Cart, Checkout, Purchase, Search, Add To Wishlist i Sign Up.
- Event zakupu na potwierdzeniu zamówienia. Hook
displayOrderConfirmationwysyła przeglądarkowy event Purchase z wartością zamówienia, walutą, ID zamówienia i danymi produktów. - Postbacki server-to-server. Kwalifikujące się konwersje mogą zostać dodane do kolejki i wysłane do Outbrain przez
https://tr.outbrain.com/unifiedPixel, gdy dostępne jest ID kliknięcia Outbrain. - Przechwytywanie ID kliknięcia. Skrypt frontowy odczytuje
ob_click_id,OutbrainClickId,outbrain_click_ididicboz landing URL-i i zapisuje wartość w cookiemproutbr_ob_click_id. - Własne reguły konwersji. Możesz definiować reguły JSON dla konwersji opartych na kliknięciu, URL-u, kontrolerze lub evencie DOM. Reguły kontrolera można opcjonalnie ograniczyć do wybranych front controllerów modułów.
- Frontowy most konwersji. Front controller
conversionodbiera chronione tokenem przeglądarkowe eventy mostu, aby dodać je do kolejki S2S. - Śledzenie rejestracji. Hook
actionCustomerAccountAddoznacza nowe konta klientów, aby kolejna strona konta mogła wysłać event Sign Up. - Ładowanie z uwzględnieniem zgody. Gdy aktywny jest
mprcookiesrevolutionlubmprcookiebanner, Pixel czeka na zgodę marketingową przed uruchomieniem. - Diagnostyka i kontrola kolejki. Strona w back office pokazuje testy gotowości, liczniki kolejki dla eventów oczekujących/wysyłanych/wysłanych/nieudanych, akcję próbną S2S oraz ponowienie dla nieudanych eventów.
- Przetwarzanie cron. Worker kolejki rejestruje
send_outbrain_conversionszschedule: every:300itimeout: 30.
Opcje konfiguracji
Ustaw je w Modules > Outbrain Pixel + S2S Postback > Configure.
- Włącz Outbrain Pixel. Włącza lub wyłącza śledzenie w przeglądarce; domyślnie:
0. - Outbrain Marketer ID. Zapisuje Twoje numeryczne Outbrain Marketer ID; domyślnie: ``. Wiele ID można oddzielić przecinkami.
- Wyklucz pracowników. Zatrzymuje śledzenie, gdy zalogowany pracownik back office przegląda front office; domyślnie:
1. - Respektuj zgodę na cookies. Czeka na zgodę marketingową z
mprcookiesrevolutionlubmprcookiebanner, gdy którykolwiek z tych modułów jest aktywny; domyślnie:1. - Śledź PageView. Wysyła event Outbrain
PAGE_VIEWz nagłówka strony; domyślnie:1. - Śledź View Content. Wysyła eventy wyświetlenia produktu na stronach produktów; domyślnie:
1. - Śledź View Category. Wysyła eventy wyświetlenia kategorii, gdy wykryta jest bieżąca kategoria; domyślnie:
1. - Śledź Add To Cart. Wysyła eventy dodania do koszyka z event busa PrestaShop lub obsługiwanych przycisków dodania do koszyka; domyślnie:
1. - Śledź Checkout. Wysyła eventy rozpoczęcia checkout, gdy moduł wykryje stronę startu checkout z produktami w koszyku; domyślnie:
1. - Śledź Purchase. Wysyła eventy zakupu na potwierdzeniu zamówienia i może dodawać postbacki zakupu do kolejki S2S; domyślnie:
1. - Śledź Search. Wysyła eventy wyszukiwania w kontrolerze wyszukiwania, gdy obecne jest
slubsearch_query; domyślnie:1. - Śledź Add To Wishlist. Wysyła eventy listy życzeń z obsługiwanych przycisków listy życzeń i event busa listy życzeń PrestaShop; domyślnie:
1. - Śledź Sign Up. Wysyła event Sign Up po utworzeniu konta klienta; domyślnie:
1. - Nazwa eventu Purchase. Określa nazwę eventu Outbrain używaną dla zakupów; domyślnie:
Purchase. - Śledź własne eventy. Włącza własne reguły konwersji definiowane w JSON; domyślnie:
0. - Reguły własnych eventów. Zapisuje tablicę JSON dla własnych reguł opartych na kliknięciu, URL-u, kontrolerze lub evencie DOM; domyślnie: ``.
- Włącz eventy postback S2S. Dodaje kwalifikujące się eventy konwersji do kolejki po stronie serwera, gdy dostępne jest ID kliknięcia Outbrain; domyślnie:
0. - Test ob_click_id. Zapisuje prawdziwe ID kliknięcia Outbrain używane wyłącznie przez administracyjny test S2S; domyślnie: ``.
- Zachowaj IP i user agent w metadanych kolejki. Zachowuje metadane IP i user-agent we wspólnej kolejce konwersji do celów diagnostycznych; domyślnie:
1. - Limit paczki kolejki. Określa, ile eventów konwersji z kolejki obsługuje procesor cron w jednym uruchomieniu; domyślnie:
20. Dozwolony zakres:1-1000.
Przykłady dostosowania
Landing URL kampanii z przechwytywaniem ID kliknięcia Outbrain:
https://www.example.com/product.html?ob_click_id={{ob_click_id}}
Wiele Marketer IDs można wpisać tak:
123456, 789012
Własna reguła eventu na podstawie kliknięcia dla interakcji z galerią produktu:
[
{
"event": "Gallery Browse",
"trigger": "click",
"selector": ".product-images img,.images-container img",
"params": {
"property": "product_gallery"
},
"s2s": true
}
]
Przycisk lead z dodatkowymi parametrami Outbrain odczytywanymi z atrybutów HTML:
<a
href="/contact"
class="js-outbrain-lead"
data-outbrain-param-property="contact_cta"
data-outbrain-param-placement="product_page"
>
Contact us
</a>
Pasująca reguła dla tego przycisku:
[
{
"event": "Lead",
"trigger": "click",
"selector": ".js-outbrain-lead",
"s2s": true
}
]
Lead event oparty na URL-u dla strony kontaktu:
[
{
"event": "Lead",
"trigger": "url",
"contains": ["/contact"],
"params": {
"property": "contact_page"
},
"s2s": true
}
]
Reguła oparta na kontrolerze, z opcjonalnym dopasowaniem modułu dla front controllerów modułów:
[
{
"event": "Lead",
"trigger": "controller",
"controllers": ["contact"],
"modules": [],
"params": {
"property": "contact_controller"
},
"once": true,
"s2s": true
}
]
Reguła eventu DOM dla własnego formularza lub skryptu motywu:
[
{
"event": "Lead",
"trigger": "event",
"dom_event": "mproutbr:lead",
"params": {
"property": "custom_form"
},
"s2s": true
}
]
JavaScript motywu, który wywołuje event DOM:
document.dispatchEvent(new CustomEvent('mproutbr:lead', {
detail: {
params: {
placement: 'footer_form',
value: 1
}
}
}));
Bezpośrednie wywołanie śledzenia w przeglądarce po uruchomieniu modułu:
if (typeof window.mproutbrTrack === 'function') {
window.mproutbrTrack('Lead', {
property: 'custom_cta',
event_source_url: window.location.href
}, true);
}
Instalacja
- Pobierz ZIP modułu ze swojego konta mypresta.rocks.
- W back office PrestaShop przejdź do Modules > Module Manager.
- Kliknij Upload a module i wybierz plik ZIP.
- Po instalacji otwórz Modules > Outbrain Pixel + S2S Postback > Configure.
- Zapisz wymagane wartości, a następnie użyj panelu diagnostycznego, aby potwierdzić stan Pixel, gotowość ID kliknięcia i status kolejki.
- Jeśli używasz postbacków S2S, dodaj parametr ID kliknięcia Outbrain do URL-i kampanii i przetestuj przez Send S2S probe, używając prawdziwego
ob_click_id.
Jak to działa
W sklepie klienci nie widzą żadnego widgetu ani banera z tego modułu. Gdy śledzenie jest aktywne, moduł ładuje Outbrain Pixel w nagłówku strony, wysyła wybrane eventy przeglądarkowe i przechwytuje ID kliknięcia Outbrain z landing URL-i kampanii.
Dla zakupów i kwalifikujących się własnych eventów moduł może też dodawać postbacki po stronie serwera do kolejki. Zadanie cron przetwarza tę kolejkę paczkami, a panel diagnostyczny pokazuje, czy eventy oczekują, są wysyłane, wysłane czy nieudane.
Uczciwe ograniczenia
- Atrybucja S2S wymaga prawdziwego ID kliknięcia Outbrain w wizycie; śledzenie Pixel w przeglądarce może działać bez niego, ale postbacki bez ID kliknięcia nie są dodawane do kolejki.
- PageView w tym module działa tylko po stronie przeglądarki i nie jest wysyłany przez most S2S.
- Test S2S wymaga prawdziwego
ob_click_idz kliknięcia reklamy Outbrain, a nie wymyślonej wartości testowej. - Oczekiwanie na zgodę działa tylko wtedy, gdy aktywny jest
mprcookiesrevolutionlubmprcookiebanneri dostępne jest cookie/event zgody. - Śledzenie Add To Cart i Add To Wishlist obsługuje typowe event busy i selektory PrestaShop; nietypowe własne motywy mogą wymagać własnej reguły eventu.
- Konfiguracja kampanii Outbrain, nazewnictwo konwersji i raportowanie w Outbrain nadal są zarządzane na Twoim koncie Outbrain.
Kompatybilność: PrestaShop 1.6 do 9.0 (najnowsza), PHP 7.1+. Nadal wspieramy nadchodzące wersje PrestaShop.