API JavaScript

Sedaya ingkang dipuncawisaken mp.js kanggé kode panjenengan: idin, ID pelanggan, prastawa khusus, langkah tanpa owah alamat, hook lan atribut HTML. Boten wonten ingkang wajib — cuplikan piyambak sampun ngrekam.

1. Kalih cara nyeluk

mp.js dipunmuat asinkron. Kode ingkang lumampah sadèrèngipun rampung nglebetaken panggilan ing antrean window.mp_q; mp.js nglampahaken sanalika sampun wonten. Sasampunipun, fungsi ingkang sami kasedhiya ing 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);

Tansah serat window.mp_q = window.mp_q || [], boten nate window.mp_q = []. mp.js tetep mirengaken array punika — array énggal badhé ngicalaken saben panggilan salajengipun, kalebet pencabutan idin.

Cuplikan instalasi ugi nemtokaken stub mp(...) ingkang ngantre kanthi cara ingkang sami. Kekalih wujud nampi printah ingkang sami: consent, set, event, step, get, on lan off.

2. Idin

Tanpa idin boten wonten ingkang dipunrekam. Menawi piranti idin panjenengan dipunkenali MousePlayer, panjenengan boten mbetahaken punika; menawi boten, lajengaken kaputusan piyambak.

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'

Pencabutan langsung lumampah ing kaca: pamiyarsa dipunbusak, data buffer dipunbucal, sambungan dipuntutup. Pirsani MousePlayer lan idin.

3. ID pelanggan panjenengan

Kanthi ID piyambak, sedaya piranti satunggal tiyang dados satunggal pengunjung ing dhaptar, lan panjenengan saged madosi kasus dhukungan mawi nomer ingkang dipunmangertosi. ID ugi dipunlampahaken ing kunjungan sadèrèngipun saking browser ingkang sami ing 30 dinten pungkasan.

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

Ginakaken nomer internal, sanès alamat email utawi jeneng. MousePlayer nedahaken ID ing saben papan pengunjung medal.

Maos ID malih

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. Prastawa khusus

Prastawa ingkang panjenengan kintun medal ing linimasa rekaman, saged dados tujuan lan langkah funnel, sarta dipunkintun dhateng webhook lan piranti sambungan. Parameter awujud nilai cekak: angka, string ngantos 255 karakter, kunci ngantos 64 karakter.

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' }]);
  • Jeneng: aksara alit kanthi garis ngandhap, paling kathah 128 karakter. Ginakaken jeneng ingkang sami kanggé prekawis ingkang sami ing pundi kemawon — tujuan cocogaken jeneng kanthi pas.
  • Boten nglebetaken data pribadi ing parameter. Parameter dipunsimpen lan dipuntedahaken kados prastawa sanès.

5. Langkah tanpa owah alamat

Checkout utawi wizard ingkang nggantos layar nanging boten alamat dipunanggep satunggal kaca déning MousePlayer. step() ndadosaken saben layar tampilan kaca piyambak — kanthi gambar kaca, larik peta panas lan langkah funnel piyambak.

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

Jeneng awujud 1 ngantos 40 karakter saking a-z, 0-9, _ lan -; spasi dados tandha pisah, sanèsipun dipuntolak kanthi pèngèt ing konsol. Pandhu arah nyata mungkasi langkah.

6. Konteks produk

Ing kaca produk, kabari MousePlayer punapa ingkang dipunpirsani. Namung kunci punika ingkang dipuntampi; sanèsipun dipunbucal supados data pelanggan boten mlebet tanpa sengaja.

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. Hook

Kode panjenengan saged nanggapi ingkang dipunukur MousePlayer ing kaca. Daftar mawi antrean menawi hook boten pareng luput wekdal kapisan.

// 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);
JenengNalikaKolom
exit_riskmodel medal sampun mènèhi skor tampilan kaca kapisan (sapisan saben kunjungan)risk, reasons, session
churn_riskpengunjung ingkang wangsul dipuntandhani kamungkinan boten wangsul malihrisk, reasons, session
offer_showntawaran nalika medal dipuntedahakenart, risk, grund, session
offer_clicktombolipun dipunklikart, risk, grund, session, fehler
offer_dismisstawaran dipuntutupart, risk, grund, session
survey_shownsurvei kabikaksurvey, trigger, session
survey_answerpengunjung mangsulisurvey, type, value, option, sentiment, session
survey_textteks susulan dipunkintun (sampun dipunsaring)survey, text, session
survey_dismisssurvei dipuntutup tanpa wangsulansurvey, step, session

Nalika jembatan GTM aktif, prastawa ingkang sami ugi mlebet dataLayer (mp_exit_risk lan sanèsipun). MousePlayer.exitRisk() ngasilaken risiko medal sapunika, utawi null sadèrèngipun dipunmangertosi.

8. Atribut HTML

<!-- 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 (utawi kelas mp-masked): teks lan isian ing salebeting unsur dipungantos sadèrèngipun medal saking browser — ing gambar kaca, owah-owahan lan andharan klik.
  • data-mp-ignore (utawi mp-ignore) ing kolom formulir: nilai boten dipunrekam babar pisan.
  • data-mp-role: satunggal saking 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. Nilai sanès dipuntilar.

9. Ngecualekaken kunjungan panjenengan piyambak

Bikak situs sapisan kanthi ?mp_exclude=1 lan browser punika boten dipunrekam malih; ?mp_exclude=0 mbatalaken punika. Kanggé jaringan kantor sedaya, lebetaken alamat IP ing setelan proyek minangka gantos.

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. Pranala kanggé kabijakan privasi

Pengunjung saged mirsani lan mbusak ingkang dipunrekam bab piyambakipun. privacyUrl() ngasilaken pranala siyap kanthi ID browser punika — utawi null menawi boten wonten, amargi tanpa idin boten wonten ingkang dipunrekam.

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