IJavaScript API - MousePlayer

1. Iindlela ezimbini zokuyibiza

I-mp.js ilayishwa ngokuzimeleyo. Ikhowudi eqhuba ngaphambi kokuba ilayishwe ibeka ubizo lwayo kumgca othi window.mp_q; i-mp.js iyawuqhuba kwakamsinya nje ukuba ifike. Emva koko kwaezo fankshini ziyafumaneka 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);

Soloko ubhala window.mp_q = window.mp_q || [], ungaze ubhale window.mp_q = []. I-mp.js iqhubeka imamele loo array - entsha ibiya kuginya lonke ubizo lwamva, kuquka ukurhoxiswa kwemvume.

Ikhowudi encinane yofakelo ikwachaza ifankshini yokulinda ethi mp(...) ebeka emgceni ngendlela efanayo. Zombini iindlela zamkela imiyalelo efanayo: consent, set, event, step, get, on ne off.

2. Imvume

Ngaphandle kwemvume akukho nto irekhodwayo. Ukuba isixhobo sakho semvume sesinye esiqondwa yiMousePlayer, awudingi nanye kwezi zinto; kungenjalo dlulisela isigqibo 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'

Ukurhoxisa kusebenza kwiphepha ngoko nangoko: izimameli ziyasuswa, idatha ekwisigcini sexeshana iyalahlwa, uqhagamshelo luyavalwa. Jonga IMousePlayer nemvume.

3. Isichongi sakho somthengi

Ngesichongi sakho, zonke izixhobo zomntu omnye ziba lundwendwe olunye kuluhlu, kwaye ungakhangela umba woncedo ngenombolo oyaziyo. Isichongi sikwasebenza kutyelelo lwangaphambili lwesikhangeli esifanayo kwiintsuku eziyi-30 zokugqibela.

// 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, hayi idilesi yeimeyile okanye igama. IMousePlayer ibonisa isichongi naphi na apho kuvela undwendwe.

Ukufunda izichongi kwakhona

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. Iziganeko ezenzelwe wena

Iziganeko ozithumelayo zivela kumgca wexesha wokudlala kwakhona, zinokuba ziinjongo namanyathelo efaneli, kwaye ziya kwiiwebhook zakho nezixhobo eziqhagamshelweyo. Iiparamitha ngamaxabiso amafutshane: amanani, imibhalo ukuya kutsho koonobumba abayi-255, izitshixo ukuya kutsho koonobumba abayi-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: ngoonobumba abancinane nezikrweqe ezisezantsi, ukuya kutsho koonobumba abayi-128. Sebenzisa igama elifanayo kwinto efanayo kuyo yonke indawo - injongo ihambelanisa amagama kanye.
Ungafaki datha yobuqu kwiiparamitha. Zigcinwa ziboniswe njengaso nasiphi na esinye isiganeko.

5. Amanyathelo ngaphandle kokutshintsha idilesi

Ukuhlawula okanye isikhokelo esinamanyathelo esitshintsha isikrini saso kodwa singatshintshi idilesi yiphepha elinye kwiMousePlayer. step() yenza isikrini ngasinye sibe kukujongwa kwephepha kwaso - sinomfanekiso waso, umqolo wemephu yobushushu nenyathelo lefaneli.

// 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 linoonobumba aba-1 ukuya kwabangama-40 abavela ku-a-z, 0-9, _ no- -; izithuba ziba ngoodwi, nantoni na eyenye iyalelwa ngesilumkiso kwikhonsoli. Ukuya kwelinye iphepha ngokwenene kuphelisa inyathelo.

6. Umongo wemveliso

Kwiphepha lemveliso, xelela iMousePlayer into ejongwayo. Kuphela ezi zitshixo zamkelwayo; yonke enye into iyalahlwa ukuze kungabikho datha yomthengi ingena ngempazamo.

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

Ikhowudi yakho inokuphendula koko kulinganiswa yiMousePlayer kwiphepha. Bhalisa ngomgca ukuba ihuku ayifanele iphose 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	Xa	Iindawo
`exit_risk`	imodeli yokuphuma inike amanqaku ekujongweni kwephepha kokuqala (kanye kutyelelo ngalunye)	`risk, reasons, session`
`churn_risk`	undwendwe olubuyayo luphawulwe njengolunokuba semngciphekweni wokungabuyi	`risk, reasons, session`
`offer_shown`	unikezelo lokuphuma luboniswa	`art, risk, grund, session`
`offer_click`	iqhosha lalo licofwa	`art, risk, grund, session, fehler`
`offer_dismiss`	luvalwa	`art, risk, grund, session`
`survey_shown`	uphando luyavuleka	`survey, trigger, session`
`survey_answer`	undwendwe luyaphendula	`survey, type, value, option, sentiment, session`
`survey_text`	umbhalo wokulandelela uthunyelwa (sele uhluziwe)	`survey, text, session`
`survey_dismiss`	uphando luvalwa ngaphandle kwempendulo	`survey, step, session`

Xa uqhagamshelo lweGTM luvuliwe, kwaezo ziganeko ziya nakwi-dataLayer (mp_exit_risk njalo njalo). MousePlayer.exitRisk() ibuyisa umngcipheko wangoku wokuphuma, okanye u-null ngaphambi kokuba waziwe.

8. Iiatribhyuthi zeHTML

<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 (okanye iklasi ethi mp-masked): umbhalo nokufakwayo ngaphakathi kwento kuyatshintshwa ngaphambi kokuba kuphume kwisikhangeli - kumfanekiso, kutshintsho nakwiinkcazelo zokucofa.
data-mp-ignore (okanye mp-ignore) kwindawo yefomu: ixabiso layo alirekhodwa kwaphela.
data-mp-role: enye kwezi 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 amaxabiso awasetyenziswa.

9. Ukungabandakanyi utyelelo lwakho

Vula isayithi yakho kube kanye nge ?mp_exclude=1 size esi sikhangeli singaphindi sirekhodwe; ?mp_exclude=0 iyakubuyisela oko. Kwinethiwekhi yonke yeofisi, faka iidilesi ze-IP kwiisetingi zeprojekthi endaweni yoko.

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

10. Ikhonkco lomgaqo-nkqubo wakho wobumfihlo

Iindwendwe zingabona zize zicime oko kurekhodiweyo ngazo. privacyUrl() ibuyisa ikhonkco elilungileyo elinesichongi sesi sikhangeli - okanye u-null ukuba asikho, kuba ngaphandle kwemvume akukho nto ibirekhodiwe.

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

Singakunceda njani?