I-JavaScript API - MousePlayer

1. Izindlela ezimbili zokuyibiza

I-mp.js ilayisha ngokuzimela. Ikhodi esebenza ngaphambi kokuba ilayishe ifaka ukubiza kwayo kulayini othi window.mp_q; i-mp.js iyawusebenza lapho isikhona. Ngemva kwalokho imisebenzi efanayo itholakala ku- 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);

Bhala njalo window.mp_q = window.mp_q || [], hhayi window.mp_q = []. I-mp.js iqhubeka ilalela kulolo hlu — olusha beluzogwinya konke ukubiza okulandelayo, kuhlanganise nokuhoxiswa kwemvume.

Ucezu lwekhodi lokufaka luphinde luchaze umsebenzi wesikhashana othi mp(...) ofaka kulayini ngendlela efanayo. Zombili izindlela zamukela imiyalo efanayo: consent, set, event, step, get, on ne- off.

2. Imvume

Ngaphandle kwemvume akukho okurekhodwayo. Uma ithuluzi lakho lemvume lingelinye elibonwa yi-MousePlayer, awukudingi lokhu; kungenjalo dlulisela isinqumo ngokwakho.

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'

Ukuhoxisa kusebenza ekhasini ngokushesha: izilaleli ziyasuswa, idatha esesilondolozini iyalahlwa, uxhumano luvalwa. Bheka I-MousePlayer nemvume.

3. I-ID yekhasimende lakho

Nge-ID yakho, wonke amadivayisi omuntu oyedwa aba yisivakashi esisodwa ezinhleni, futhi ungasesha udaba losizo ngenombolo oyaziyo. I-ID ifakwa nasekuvakasheni kwangaphambilini kwesiphequluli esifanayo sezinsuku ezingu-30 ezedlule.

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

Sebenzisa inombolo yangaphakathi, hhayi ikheli le-imeyili noma igama. I-MousePlayer ibonisa i-ID noma kuphi lapho isivakashi sivela khona.

Ukufunda ama-ID ubuyise

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. Izehlakalo zangokwezifiso

Izehlakalo ozithumelayo zivela emugqeni wesikhathi wokudlala kabusha, zingaba imigomo nezinyathelo zefaneli, futhi ziya kuma-webhook akho namathuluzi axhunyiwe. Amapharamitha angamanani amafushane: izinombolo, imibhalo efinyelela ezinhlamvini ezingu-255, okhiye abafinyelela ezinhlamvini ezingu-64.

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

Amagama: izinhlamvu ezincane ezinomaka abangaphansi, izinhlamvu ezingu-128 kakhulu. Sebenzisa igama elifanayo entweni efanayo yonke indawo — umgomo ufanisa amagama ngokunembile.
Ungafaki idatha yomuntu siqu kumapharamitha. Agcinwa futhi aboniswe njengazo zonke ezinye izehlakalo.

5. Izinyathelo ngaphandle kokushintsha ikheli

Ukukhokha noma umsizi oshintsha isikrini kodwa angashintshi ikheli uyikhasi elilodwa ku-MousePlayer. step() yenza isikrini ngasinye sibe ukubukwa kwekhasi kwaso — nesithombe saso sekhasi, umugqa wemephu yokushisa nesinyathelo sefaneli.

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

Igama linezinhlamvu ezingu-1 kuya kwezingu-40 ezivela ku-a-z, 0-9, _ kanye nohlamvu oluthi -; izikhala ziba amadeshi, noma yini enye iyenqatshwa ngesixwayiso kukhonsoli. Ukuzulazula kwangempela kuqeda isinyathelo.

6. Umongo womkhiqizo

Ekhasini lomkhiqizo, tshela i-MousePlayer ukuthi yini ebukwayo. Kwamukelwa laba khiye kuphela; konke okunye kuyalahlwa ukuze kungangeni idatha yekhasimende ngephutha.

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. Ama-hook

Ikhodi yakho ingaphendula kulokho i-MousePlayer ekulinganisa ekhasini. Bhalisa kulayini uma i-hook ingafanele iphuthwe umzuzu wokuqala.

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

Igama	Nini	Izinkambu
`exit_risk`	imodeli yokuphuma isinike amaphuzu ukubukwa kwekhasi kokuqala (kanye ngokuvakasha)	`risk, reasons, session`
`churn_risk`	isivakashi esibuyile simakwe njengesingase singabe sisabuya	`risk, reasons, session`
`offer_shown`	umnikelo lapho kuphunywa ubonisiwe	`art, risk, grund, session`
`offer_click`	inkinobho yawo ichofoziwe	`art, risk, grund, session, fehler`
`offer_dismiss`	uvaliwe	`art, risk, grund, session`
`survey_shown`	inhlolovo ivuliwe	`survey, trigger, session`
`survey_answer`	isivakashi siyaphendula	`survey, type, value, option, sentiment, session`
`survey_text`	umbhalo wombuzo olandelayo uthunyelwe (usuvele uhlungiwe)	`survey, text, session`
`survey_dismiss`	inhlolovo ivaliwe ngaphandle kwempendulo	`survey, step, session`

Uma ibhuloho le-GTM livuliwe, izehlakalo ezifanayo zingena naku-dataLayer (mp_exit_risk nokunye). MousePlayer.exitRisk() ibuyisa ingozi yamanje yokuphuma, noma i-null uma ingakaziwa.

8. Izimfanelo ze-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 (noma isigaba esithi mp-masked): umbhalo nokufakiwe ngaphakathi kwesici kushintshwa ngaphambi kokushiya isiphequluli — esithombeni sekhasi, ezinguqukweni nasezincazelweni zokuchofoza.
data-mp-ignore (noma mp-ignore) enkambini yefomu: inani layo alirekhodwa nhlobo.
data-mp-role: okukodwa kokuthi 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. Amanye amanani ayazitshwa.

9. Ukungafaki ukuvakasha kwakho

Vula isayithi lakho kanye nge- ?mp_exclude=1 bese lesi siphequluli singasarekhodwa; ?mp_exclude=0 kuyakuhlehlisa. Enethiwekhi yehhovisi lonke, faka amakheli e-IP kuzilungiselelo zephrojekthi esikhundleni salokho.

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

10. Isixhumanisi senqubomgomo yakho yobumfihlo

Izivakashi zingabona futhi zisuse okurekhodwe ngazo. privacyUrl() ibuyisa isixhumanisi esilungile esine-ID yalesi siphequluli — noma i-null uma ingekho, ngoba ngaphandle kwemvume akukho okurekhodiwe.

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

Singakusiza kanjani?