JavaScript API - MousePlayer

1. Żewġ modi

mp.js asinkroniku. Kodiċi qabel it-tagħbija jpoġġi sejħiet fil-kju window.mp_q; mp.js jaħdimhom malli jasal. Wara l-istess funzjonijiet fuq window.MousePlayer.

// Before mp.js has loaded - the queue keeps every call: (window.mp_q = window.mp_q || []).push(['consent', true]); // After mp.js has loaded - the same, directly: MousePlayer.setConsent(true);

Dejjem window.mp_q = window.mp_q || [], qatt window.mp_q = []. mp.js jibqa’ jisma’ l-array; ġdid jibla’ sejħiet oħra, inkluż irtirar.

Snippet jiddefinixxi stub mp(...) għall-istess kju. L-istess kmandi: consent, set, event, step, get, on u off.

2. Kunsens

Bla kunsens xejn. Jekk CMP magħruf, m’għandkomx bżonn dan; inkella għaddu d-deċiżjoni.

MousePlayer.setConsent(true); // the visitor agreed MousePlayer.setConsent(false); // withdrawn: recording stops on this page MousePlayer.getConsentState(); // e.g. 'WAITING', 'GRANTED', 'GRANTED_LATE', 'DENIED', 'WITHDRAWN'

Irtirar immedjat: listeners jitneħħew, buffer jintrema, konnessjoni tingħalaq. Araw MousePlayer u kunsens.

3. ID tal-klijent

ID tagħkom jagħmel l-apparati persuna waħda u tista’ ssibu każ bin-numru magħruf. Japplika wkoll għal żjarat tal-istess browser fl-aħħar 30 jum.

// After login - your own customer number, not an e-mail address: MousePlayer.setUserId('customer-4711'); // or through the queue (window.mp_q = window.mp_q || []).push(['set', 'user_id', 'customer-4711']);

Numru intern, mhux email jew isem. Jidher kull fejn il-viżitatur.

Qari tal-IDs

MousePlayer.getSessionUrl(); // replay link of the running session MousePlayer.getSessionId(); MousePlayer.getVisitorId(); // null without consent // Through the queue, with a callback: (window.mp_q = window.mp_q || []).push(['get', 'session_url', function (url) { // e.g. attach it to a support ticket }]);

4. Avvenimenti personalizzati

Jidhru fit-timeline, jistgħu jkunu għanijiet jew passi, u jmorru f’webhooks u għodod. Valuri qosra: numri, strings sa 255, ċwievet sa 64 karattru.

MousePlayer.trackEvent('newsletter_signup', { source: 'footer' }); MousePlayer.trackEvent('purchase', { value: 129.90, currency: 'EUR' }); (window.mp_q = window.mp_q || []).push(['event', 'add_to_cart', { sku: 'SKU-123' }]);

Ismijiet żgħar b’underscores, sa 128 karattru. L-istess ħaġa l-istess isem: taqbil eżatt.
Ebda data personali fil-parametri; jinħażnu u jidhru bħal avvenimenti oħra.

5. Passi bla bidla fl-indirizz

Checkout jew wizard li jbiddel skrin mhux indirizz huwa paġna waħda. step() jagħmel kull skrin dehra separata bi snapshot, mappa u pass tagħha.

// A wizard that keeps its address: MousePlayer.step('shipping'); MousePlayer.step('payment'); MousePlayer.step(''); // back to the page itself (window.mp_q = window.mp_q || []).push(['step', 'payment']);

Isem 1 sa 40 karattru minn a-z, 0-9, _ u -; spazji jsiru sing, oħrajn miċħuda b’console warning. Navigazzjoni reali ttemm il-pass.

6. Kuntest tal-prodott

Għidu x’qed jidher fil-paġna tal-prodott. Dawn iċ-ċwievet biss; oħrajn jintremew biex ma tidħolx data tal-klijenti bi żball.

MousePlayer.setContext({ page_type: 'product', product_id: 'SKU-123', variant_id: 'SKU-123-42', price: 89.90, currency: 'EUR', category: 'running-shoes', in_stock: true, cart_value: 0, cart_items: 0 });

7. Hooks

Kodiċi jista’ jirreaġixxi għall-kejl. Irreġistraw bil-kju biex ma jitlifx l-ewwel mument.

// Register early - exit_risk fires once, a few seconds after the visit starts: (window.mp_q = window.mp_q || []).push(['on', 'exit_risk', function (e) { console.log(e.risk, e.reasons, e.session); }]); function onAnswer(e) { /* e.survey, e.value, e.sentiment */ } MousePlayer.on('survey_answer', onAnswer); MousePlayer.off('survey_answer', onAnswer);

Isem	Meta	Oqsma
`exit_risk`	mudell tal-ħruġ jagħti punteġġ lill-ewwel dehra (darba kull żjara)	`risk, reasons, session`
`churn_risk`	viżitatur li jirritorna mmarkat għat-tluq permanenti	`risk, reasons, session`
`offer_shown`	offerta tal-ħruġ tidher	`art, risk, grund, session`
`offer_click`	buttuna tagħha kklikkjata	`art, risk, grund, session, fehler`
`offer_dismiss`	tingħalaq	`art, risk, grund, session`
`survey_shown`	stħarriġ jinfetaħ	`survey, trigger, session`
`survey_answer`	viżitatur iwieġeb	`survey, type, value, option, sentiment, session`
`survey_text`	test sussegwenti mibgħut (diġà ffiltrat)	`survey, text, session`
`survey_dismiss`	stħarriġ magħluq bla tweġiba	`survey, step, session`

Bil-GTM bridge, l-istess fid-dataLayer (mp_exit_risk eċċ.). MousePlayer.exitRisk() jirritorna riskju attwali, jew null qabel ikun magħruf.

8. Attributi HTML

<section data-mp-mask> ... </section>  <input name="voucher" data-mp-ignore>  <span class="amount" data-mp-role="price">89,90 EUR</span>

data-mp-mask (jew klassi mp-masked): test u input jinbidlu qabel jitilqu mill-browser, fis-snapshot, bidliet u deskrizzjonijiet tal-klikks.
data-mp-ignore (jew mp-ignore) fuq qasam: il-valur qatt ma jiġi rreġistrat.
data-mp-role: wieħed minn price, price_old, cta_cart, cta_checkout, product_image, variant, shipping_info, returns_info, reviews, rating, stock, coupon, payment_methods, search, filter, heading, article_body, nav, media, form_field, contact_info. Oħrajn injorati.

9. Eskludu żjarat tagħkom

Iftħu s-sit darba b’ ?mp_exclude=1 u l-browser ma jiġix irreġistrat aktar; ?mp_exclude=0 ineħħi l-effett. Għal uffiċċju sħiħ, IPs fis-settings.

https://www.your-shop.com/?mp_exclude=1  https://www.your-shop.com/?mp_exclude=0

10. Link għall-politika tal-privatezza

Viżitaturi jaraw u jħassru r-rekords tagħhom. privacyUrl() jagħti link bl-ID tal-browser, jew null għax bla kunsens xejn ma ġie rreġistrat.

var link = MousePlayer.privacyUrl(); // language from <html lang>, or e.g. privacyUrl('de') if (link) document.getElementById('my-data').href = link;

Kif nistgħu ngħinu?