JavaScript API

Allt sem mp.js býður eigin kóða þínum: samþykki, viðskiptavinaauðkenni, sérsniðna atburði, skref án slóðarbreytingar, króka og HTML-eigindi. Ekkert hér er nauðsynlegt — kóðabúturinn einn tekur upp.

1. Tvær leiðir til að kalla

mp.js hleðst ósamstillt. Kóði sem keyrir áður en það hefur hlaðist setur köllin sín í biðröðina window.mp_q; mp.js vinnur hana um leið og það er til staðar. Eftir það eru sömu aðgerðir tiltækar á 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);

Skrifaðu alltaf window.mp_q = window.mp_q || []en aldrei window.mp_q = []. mp.js heldur áfram að hlusta á fylkið — nýtt fylki myndi gleypa öll síðari köll, líka afturköllun samþykkis.

Uppsetningarkóðabúturinn skilgreinir líka staðgengilsfallið mp(...) sem setur í biðröð á sama hátt. Bæði snið taka sömu skipanir: consent, set, event, step, get, on og off.

2. Samþykki

Án samþykkis er ekkert tekið upp. Ef samþykkistólið þitt er meðal þeirra sem MousePlayer þekkir þarftu ekkert af þessu; annars sendirðu ákvörðunina sjálf(ur).

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'

Afturköllun tekur strax gildi á síðunni: hlustarar fjarlægðir, gögnum í biðminni hent og tengingu lokað. Sjá MousePlayer og samþykki.

3. Þitt viðskiptavinaauðkenni

Með eigin auðkenni verða öll tæki einnar manneskju að einum gesti í listum og þú getur leitað að þjónustumáli með númeri sem þú þekkir. Auðkennið gildir líka fyrir fyrri heimsóknir sama vafra síðustu 30 daga.

// 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']);

Notaðu innra númer en ekki netfang eða nafn. MousePlayer sýnir auðkennið alls staðar þar sem gesturinn birtist.

Lesa auðkenni til baka

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. Sérsniðnir atburðir

Atburðir sem þú sendir birtast á tímalínu endurspilunar, geta verið markmið og trektarskref og fara í vefkróka og tengd tól. Viðföng eru stutt gildi: tölur, strengir allt að 255 stöfum og lyklar allt að 64 stöfum.

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' }]);
  • Heiti: lágstafir með undirstrikum, mest 128 stafir. Notaðu sama heiti fyrir sama hlut alls staðar — markmið samsvarar heitum nákvæmlega.
  • Ekki setja persónuupplýsingar í viðföng. Þau eru geymd og sýnd eins og aðrir atburðir.

5. Skref án slóðarbreytingar

Greiðsluferli eða leiðarvísir sem breytir skjánum en ekki slóðinni er ein síða fyrir MousePlayer. step() gerir hvern skjá að eigin síðuskoðun — með eigin skyndimynd, hitakortslínu og trektarskrefi.

// 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']);

Heiti er 1 til 40 stafir úr a-z, 0-9, _ og -; bil verða bandstrik og öðru er hafnað með viðvörun í stjórnborði. Raunverulegt flakk lýkur skrefinu.

6. Vörusamhengi

Segðu MousePlayer á vörusíðu hvað er skoðað. Aðeins þessir lyklar eru samþykktir; öllu öðru er hent svo engin viðskiptavinagögn læðist inn óvart.

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. Krókar

Kóðinn þinn getur brugðist við því sem MousePlayer mælir á síðunni. Skráðu í gegnum biðröðina ef krókurinn má ekki missa af fyrstu stundinni.

// 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);
HeitiHvenærReitir
exit_riskbrottfararlíkanið hefur metið fyrstu síðuskoðun (einu sinni í heimsókn)risk, reasons, session
churn_riskendurkomugestur er merktur líklegur til að hætta að komarisk, reasons, session
offer_shownbrottfarartilboðið birtistart, risk, grund, session
offer_clicksmellt er á hnapp þessart, risk, grund, session, fehler
offer_dismissþví er lokaðart, risk, grund, session
survey_shownkönnun opnastsurvey, trigger, session
survey_answergesturinn svararsurvey, type, value, option, sentiment, session
survey_texteftirfylgnitextinn er sendur (þegar síaður)survey, text, session
survey_dismisskönnuninni er lokað án svarssurvey, step, session

Þegar GTM-brúin er virk fara sömu atburðir líka í dataLayer (mp_exit_risk og svo framvegis). MousePlayer.exitRisk() skilar núverandi brottfararhættu eða null áður en hún er þekkt.

8. HTML-eigindi

<!-- Nothing typed in here leaves the browser as text --> <section data-mp-mask> ... </section> <!-- The value of this field is never recorded --> <input name="voucher" data-mp-ignore> <!-- Tell MousePlayer what an element is --> <span class="amount" data-mp-role="price">89,90 EUR</span>
  • data-mp-mask (eða klasinn mp-masked): texta og innslætti inni í stakinu er skipt út áður en það fer úr vafranum — í skyndimynd, breytingum og smellilýsingum.
  • data-mp-ignore (eða mp-ignore) á eyðublaðsreit: gildi hans er alls ekki skráð.
  • data-mp-role: eitt af 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. Önnur gildi eru hunsuð.

9. Útiloka eigin heimsóknir

Opnaðu vefsvæðið einu sinni með ?mp_exclude=1 og þessi vafri er ekki lengur tekinn upp; ?mp_exclude=0 afturkallar það. Fyrir allt skrifstofunetið skaltu í staðinn færa IP-tölurnar í verkefnisstillingar.

https://www.your-shop.com/?mp_exclude=1 <!-- this browser is not recorded any more --> https://www.your-shop.com/?mp_exclude=0 <!-- recorded again -->

10. Tengill fyrir persónuverndarstefnuna

Gestir geta séð og eytt því sem var skráð um þá. privacyUrl() skilar tilbúnum tengli með auðkenni þessa vafra — eða null ef það er ekkert því án samþykkis var ekkert skráð.

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