API JavaScript

Waan mp.js koodii mataa keessaniif kennu hunda: hayyama, ID maamilaa keessanii, taatee dhuunfaa, tarkaanfii teessoo hin jijjiirre, hook fi amaloota HTML. Asitti wanti barbaachisu hin jiru — kutaan koodii qofaan ni waraaba.

1. Karaa lama ittiin waaman

mp.js hojii biroo osoo hin eeggin fe'ama. Koodiin osoo inni hin fe'amin hojjetu okuu isaa tarree window.mp_qkeessa kaa'a; mp.js argamuun battalumatti keessa hojjeta. Sana booda faankishiniin walfakkaataan window.MousePlayerirratti ni argamu.

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

Yeroo hunda window.mp_q = window.mp_q || []barreessaa, gonkumaa window.mp_q = []hin barreessinaa. mp.js array sana dhaggeeffachuu itti fufa — haaraan okuu boodaa hunda, hayyama deebisanii fudhachuu dabalatee, liqimsa ture.

Kutaan koodii fe'umsaa stub mp(...) kan haala walfakkaataan tarree keessa galchu illee ibsa. Bifni lamaan ajaja walfakkaataa fudhatu: consent, set, event, step, get, on fi off.

2. Hayyama

Hayyama malee wanti waraabamu hin jiru. Meeshaan hayyamaa keessan kan MousePlayer beeku yoo ta'e, kana keessaa homaa isin hin barbaachisu; yoo kana hin taane murtoo ofiin dabarsaa.

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'

Deebisanii fudhachuun battalumatti fuula irratti hojjeta: dhaggeeffattoonni haqamu, deetaan buffer keessa jiru gatama, walitti dhufeenyi cufama. Kana ilaalaa MousePlayer fi hayyama.

3. ID maamilaa keessanii

ID mataa keessanii waliin meeshaaleen nama tokkoo hundi tarree keessatti daawwataa tokko ta'u, rakkoo deeggarsaas lakkoofsa beektaniin barbaaduu dandeessu. IDn daawwannaa duraa biraawzarii walfakkaataa guyyoota 30 darban keessattis ni dabala.

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

Lakkoofsa keessaa fayyadamaa, teessoo imeelii yookaan maqaa miti. MousePlayer bakka daawwataan mul'atu hundatti ID agarsiisa.

ID irra deebi'anii dubbisuu

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. Taateewwan dhuunfaa

Taateewwan ergitan sarara yeroo irra deebi'anii taphachiisuu irratti mul'atu, galmaa fi tarkaanfii ujummoo ta'uu danda'u, gara webhook fi meeshaalee keessan walqabatanitti deemu. Parametaroonni gatii gabaabaa dha: lakkoofsa, string hanga qubee 255, furtuu hanga qubee 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' }]);
  • Maqaawwan: qubee xiqqaa underscore waliin, baay'inaan qubee 128. Waan walfakkaataaf bakka hundaatti maqaa walfakkaataa fayyadamaa — galmi maqaa sirriitti walsimsiisa.
  • Deetaa dhuunfaa parametarii keessatti hin kaa'inaa. Akka taatee biraa kamiitti kuufamanii mul'atu.

5. Tarkaanfii teessoo hin jijjiirre

Kaffaltii xumuruu yookaan wizard iskiriinii isaa jijjiiru garuu teessoo isaa hin jijjiirre MousePlayer tiif fuula tokko. step() iskiriinii hunda mul'ata fuulaa mataa isaa taasisa — suuraa, sarara kaartaa ho'aa fi tarkaanfii ujummoo mataa isaa waliin.

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

Maqaan qubee 1 hanga 40 a-z, 0-9, _ fi - keessaa; bakki duwwaan hyphen ta'a, wanti biraa hundi akeekkachiisa console keessatti kennamuun didama. Navigeeshiniin dhugaa tarkaanfii xumura.

6. Haala oomishaa

Fuula oomishaa irratti waan ilaalamu MousePlayer tti himaa. Furtuuwwan kana qofa fudhata; wanti biraa hundi deetaan maamilaa dogoggoraan akka hin seenneef gatama.

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

Koodiin keessan waan MousePlayer fuula irratti safaruuf deebisuu danda'a. Hook yeroo jalqabaa dhabuu hin qabne yoo ta'e karaa tarreetiin galmeessaa.

// 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);
MaqaaYoomDirreewwan
exit_riskmoodeelli ba'uu mul'ata fuulaa jalqabaaf qabxii kenneera (daawwannaa tokkoon yeroo tokko)risk, reasons, session
churn_riskdaawwataan deebi'e akka deebi'uu dhiisuu danda'utti mallatteeffamerisk, reasons, session
offer_showndhiyeessiin ba'uu agarsiifameart, risk, grund, session
offer_clickbotiiniin isaa cuqaafameart, risk, grund, session, fehler
offer_dismisscufameart, risk, grund, session
survey_shownqorannoon gaaffii banamesurvey, trigger, session
survey_answerdaawwataan deebisasurvey, type, value, option, sentiment, session
survey_textbarruun itti aanu ergama (dursee calalame)survey, text, session
survey_dismissqorannoon gaaffii deebii malee cufamasurvey, step, session

Riqichi GTM yeroo baname, taateewwan walfakkaataa gara dataLayer tti deemu (mp_exit_risk fi kkf). MousePlayer.exitRisk() balaa ba'uu ammaa deebisa, yookaan osoo hin beekamin dura null.

8. Amaloota 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 (yookaan class mp-masked): barruu fi galteen wanticha keessaa biraawzarii keessaa ba'uu dura bakka buufamu — suuraa fuulaa, jijjiiramoota fi ibsa cuqaasaa keessatti.
  • data-mp-ignore (yookaan mp-ignore) dirree unkaa irratti: gatiin isaa gonkumaa hin waraabamu.
  • data-mp-role: 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 keessaa tokko. Gatiin biraa tuffatama.

9. Daawwannaa mataa keessanii keessaa baasuu

Marsariitii keessan yeroo tokko kana waliin banaa ?mp_exclude=1 biraawzariin kun kana booda hin waraabamu; ?mp_exclude=0 deebisa. Neetworkii waajjiraa guutuuf bakka isaa teessoo IP qindaa'inoota pirojektii keessatti galchaa.

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. Liinkii imaammata iccitii keessaniif

Daawwattoonni waan waa'ee isaanii waraabame arguu fi haquu danda'u. privacyUrl() liinkii qophaa'e ID biraawzarii kanaa waliin deebisa — yookaan yoo hin jirre null, sababni isaas hayyama malee wanti hin waraabamne.

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