API JavaScript

Izay rehetra omen'ny mp.js ny kaodinao: fanekena, ID mpanjifanao, hetsika manokana, dingana tsy manova adiresy, hook ary toetra HTML. Tsy misy takiana eto - ny snippet irery dia mandrakitra.

1. Fomba roa iantsoana azy

Ampidirina tsy miandry ny mp.js. Ny kaody mandeha alohan'ny hampidirana azy dia mametraka ny antsony ao amin'ny filaharana window.mp_q; karakarain'ny mp.js izany raha vao tonga izy. Avy eo dia misy ireo fiasa mitovy eo amin'ny 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);

Soraty mandrakariva window.mp_q = window.mp_q || [], fa aza window.mp_q = [] mihitsy. Mbola mihaino an'io array io ny mp.js - ny vaovao dia hitelina ny antso rehetra manaraka, anisan'izany ny fanafoanana fanekena.

Mamaritra solon-toerana mp(...) mametraka filaharana amin'ny fomba mitovy koa ny snippet fametrahana. Samy mandray ireo baiko mitovy ny endrika roa: consent, set, event, step, get, on ary off.

2. Fanekena

Tsy misy firaketana raha tsy misy fanekena. Raha iray amin'ireo fantatry ny MousePlayer ny fitaovana fanekenao dia tsy mila ireo ianao; raha tsy izany dia ampitao samirery ny fanapahan-kevitra.

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'

Mihatra avy hatrany eo amin'ny pejy ny fanafoanana: esorina ny mpihaino, ariana ny angona voatahiry vetivety, ary akatona ny fifandraisana. Jereo MousePlayer sy fanekena.

3. Ny ID mpanjifanao

Amin'ny ID anao manokana dia lasa mpitsidika iray ao amin'ny lisitra ny fitaovana rehetra an'ny olona iray, ary afaka mitady raharaha fanohanana amin'ny laharana fantatrao ianao. Ampiharina amin'ny fitsidihana taloha tamin'ilay mpitety ihany nandritra ny 30 andro farany koa ny ID.

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

Mampiasà laharana anatiny, fa tsy adiresy mailaka na anarana. Asehon'ny MousePlayer na aiza na aiza isehoan'ny mpitsidika ilay ID.

Famakiana ID miverina

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. Hetsika manokana

Miseho ao amin'ny fizotry ny famerenana ireo hetsika alefanao, afaka ho tanjona sy dingana funnel, ary mandeha any amin'ny webhook sy fitaovana mifandray aminao. Sanda fohy ny masontsivana: isa, lahatsoratra hatramin'ny tarehintsoratra 255, lakile hatramin'ny tarehintsoratra 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' }]);
  • Anarana: litera madinika miaraka amin'ny tsipika ambany, tarehintsoratra 128 farafahabetsany. Ampiasao ny anarana mitovy ho an'ny zavatra mitovy na aiza na aiza - ampifanarahin'ny tanjona tanteraka ny anarana.
  • Aza mametraka angona manokana ao amin'ny masontsivana. Tehirizina sy aseho tahaka ny hetsika hafa rehetra izy ireo.

5. Dingana tsy manova adiresy

Pejy iray ihany ho an'ny MousePlayer ny checkout na mpitari-dalana manova ny efijery fa tsy ny adiresiny. step() no mahatonga ny efijery tsirairay ho fijerena pejy misaraka - miaraka amin'ny sarin'ny pejy, andalana sarintanin'ny hafanana ary dingana funnel azy manokana.

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

Tarehintsoratra 1 ka hatramin'ny 40 avy amin'ny a-z, 0-9, _ ary - ny anarana; lasa tsipi-panohizana ny elanelana, ary lavina miaraka amin'ny fampitandremana ao amin'ny console ny zavatra hafa. Mamarana ilay dingana ny fivezivezena tena mankany amin'ny pejy hafa.

6. Toe-javatra momba ny vokatra

Ao amin'ny pejin'ny vokatra, lazao amin'ny MousePlayer izay jerena. Ireto lakile ireto ihany no ekena; ariana ny zavatra hafa rehetra mba tsy hisy angon'ny mpanjifa hiditra tsy nahy.

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

Afaka mamaly izay refesin'ny MousePlayer eo amin'ny pejy ny kaodinao. Misorata amin'ny filaharana raha tsy tokony ho diso ilay fotoana voalohany ny hook.

// 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);
AnaranaRahovianaSaha
exit_riskefa nomen'ny modely fialana naoty ny fijerena pejy voalohany (indray mandeha isaky ny fitsidihana)risk, reasons, session
churn_riskvoamarika ho mety tsy hiverina ny mpitsidika miverinarisk, reasons, session
offer_shownaseho ny tolotra rehefa hialaart, risk, grund, session
offer_clicktsindriana ny bokotranyart, risk, grund, session, fehler
offer_dismissakatona izyart, risk, grund, session
survey_shownmisokatra ny fanadihadianasurvey, trigger, session
survey_answermamaly ny mpitsidikasurvey, type, value, option, sentiment, session
survey_textalefa ny lahatsoratra fanampiny (efa voasivana)survey, text, session
survey_dismissakatona tsy misy valiny ny fanadihadianasurvey, step, session

Rehefa mandeha ny tetezana GTM dia mandeha any amin'ny dataLayer koa ireo hetsika ireo (mp_exit_risk sy ny sisa). MousePlayer.exitRisk() no mamerina ny loza mety hialana ankehitriny, na null raha mbola tsy fantatra.

8. Toetra 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 (na ny kilasy mp-masked): soloina ny lahatsoratra sy ny zavatra nampidirina ao anatin'ilay singa alohan'ny hialany amin'ny mpitety - ao amin'ny sarin'ny pejy, fanovana ary famaritana tsindry.
  • data-mp-ignore (na mp-ignore) eo amin'ny saha endrika: tsy raketina mihitsy ny sandany.
  • data-mp-role: iray amin'ny 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. Tsy raharahaina ny sanda hafa.

9. Fanilihana ny fitsidihanao manokana

Sokafy indray mandeha amin'ny ?mp_exclude=1 ny tranonkalanao dia tsy raketina intsony ity mpitety ity; ?mp_exclude=0 no manafoana izany. Ho an'ny tambajotran'ny birao manontolo dia ampidiro kosa ao amin'ny fikirana tetikasa ny adiresy IP.

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. Rohy ho an'ny politikanao momba ny fiainana manokana

Afaka mahita sy mamafa izay voarakitra momba azy ny mpitsidika. privacyUrl() no mamerina ilay rohy efa vonona misy ny ID an'ity mpitety ity - na null raha tsy misy, satria tsy nisy voarakitra raha tsy nisy fanekena.

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