API JavaScript

Gbogbo ohun tí mp.js pèsè fún kóòdù tiyín: ìfọwọ́sí, ID oníbàárà yín, ìṣẹ̀lẹ̀ tiyín, ìgbésẹ̀ láìsí àyípadà àdírẹ́sì, hook àti attribute HTML. Kò sí ohun níbí tó jẹ́ dandan — snippet nìkan ń gbàsílẹ̀.

1. Ọ̀nà méjì láti pè é

mp.js ń wọlé lọ́tọ̀. Kóòdù tó ṣiṣẹ́ kí ó tó wọlé ń fi ìpè rẹ̀ sínú ìlà window.mp_q; mp.js ń ṣiṣẹ́ wọn ní kété tí ó bá wà. Lẹ́yìn náà function kan náà wà lórí 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);

Ẹ máa kọ window.mp_q = window.mp_q || [] nígbà gbogbo, kì í ṣe window.mp_q = []. mp.js ṣì ń gbọ́ lórí array yẹn — tuntun yóò gbé gbogbo ìpè lẹ́yìn náà mì, pẹ̀lú yíyọ ìfọwọ́sí padà.

Snippet fífi sori ẹrọ tún ń ṣàlàyé stub mp(...) tó ń fi sí ìlà ní ọ̀nà kan náà. Ìrísí méjèèjì gba àṣẹ kan náà: consent, set, event, step, get, on àti off.

2. Ìfọwọ́sí

Láìsí ìfọwọ́sí a kò gbàsílẹ̀ ohunkóhun. Bí irinṣẹ́ ìfọwọ́sí yín bá jẹ́ èyí tí MousePlayer mọ̀, ẹ kò nílò ohunkóhun nínú èyí; bí bẹ́ẹ̀ kọ́, ẹ fi ìpinnu ránṣẹ́ fúnra yín.

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'

Yíyọ ìfọwọ́sí padà ní ipa lórí ojú ìwé lẹ́sẹ̀kẹsẹ̀: a yọ olùgbọ́ kúrò, a sọ dátà buffer nù, a pa ìsopọ̀ dé. Ẹ wo MousePlayer àti ìfọwọ́sí.

3. ID oníbàárà yín

Pẹ̀lú ID tiyín, gbogbo ẹ̀rọ ènìyàn kan di àlejò kan nínú àtòjọ, ẹ sì lè wá ọ̀ràn ìrànlọ́wọ́ nípa nọ́ńbà tí ẹ mọ̀. A tún lo ID fún ìbẹ̀wò ṣáájú ti aṣàwákiri kan náà láti ọjọ́ 30 tó kọjá.

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

Ẹ lo nọ́ńbà inú, kì í ṣe àdírẹ́sì ímeèlì tàbí orúkọ. MousePlayer ń fi ID hàn níbi gbogbo tí àlejò hàn.

Kíkà ID padà

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. Ìṣẹ̀lẹ̀ tiyín

Ìṣẹ̀lẹ̀ tí ẹ fi ránṣẹ́ ń hàn nínú ìlà àkókò ìtúnṣeré, wọ́n lè jẹ́ àfojúsùn àti ìgbésẹ̀ funnel, wọ́n sì ń lọ sí webhook yín àti irinṣẹ́ tí a so pọ̀. Parameter jẹ́ iye kúkúrú: nọ́ńbà, ọ̀rọ̀ títí dé lẹ́tà 255, key títí dé lẹ́tà 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' }]);
  • Orúkọ: lẹ́tà kékeré pẹ̀lú underscore, lẹ́tà 128 tó pọ̀ jù. Ẹ lo orúkọ kan náà fún ohun kan náà níbi gbogbo — àfojúsùn ń bá orúkọ mu gẹ́lẹ́.
  • Ẹ má fi dátà ara ẹni sínú parameter. A fi wọ́n pamọ́, a sì fi hàn bí ìṣẹ̀lẹ̀ èyíkéyìí mìíràn.

5. Ìgbésẹ̀ láìsí àyípadà àdírẹ́sì

Checkout tàbí irinṣẹ́ ìtọ́sọ́nà tó ń yí ojú ìbòjú rẹ̀ padà ṣùgbọ́n tí kò yí àdírẹ́sì rẹ̀ jẹ́ ojú ìwé kan fún MousePlayer. step() ń sọ ojú ìbòjú kọ̀ọ̀kan di ìwò ojú ìwé tirẹ̀ — pẹ̀lú àwòrán ojú ìwé, ìlà àwòrán ooru àti ìgbésẹ̀ funnel tirẹ̀.

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

Orúkọ jẹ́ lẹ́tà 1 sí 40 láti a-z, 0-9, _ àti -; ààyè di hyphen, a kọ ohunkóhun yòókù pẹ̀lú ìkìlọ̀ nínú console. Ìrìn kiri gidi ń parí ìgbésẹ̀.

6. Àyíká ọjà

Lórí ojú ìwé ọjà, ẹ sọ ohun tí a ń wò fún MousePlayer. Key wọ̀nyí nìkan ni a gbà; a sọ gbogbo ohun yòókù nù kí dátà oníbàárà má bàa wọlé ní àṣìṣe.

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

Kóòdù yín lè fèsì sí ohun tí MousePlayer ń wọn lórí ojú ìwé. Ẹ forúkọ sílẹ̀ nípasẹ̀ ìlà bí hook kò bá gbọ́dọ̀ pàdánù àkókò àkọ́kọ́.

// 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);
OrúkọÌgbàPápá
exit_riskàwòṣe ìjáde ti fún ìwò ojú ìwé àkọ́kọ́ ní àmì (lẹ́ẹ̀kan fún ìbẹ̀wò)risk, reasons, session
churn_riska samisi àlejò tó padà wá gẹ́gẹ́ bí ẹni tó ṣeé ṣe kó má padà mọ́risk, reasons, session
offer_showna fi àǹfààní ìjáde hànart, risk, grund, session
offer_clicka tẹ bọ́tìnnì rẹ̀art, risk, grund, session, fehler
offer_dismissa pa á déart, risk, grund, session
survey_shownìwádìí ṣísurvey, trigger, session
survey_answeràlejò dáhùnsurvey, type, value, option, sentiment, session
survey_texta fi ọ̀rọ̀ àfikún ránṣẹ́ (a ti ṣe àlẹ̀mọ́)survey, text, session
survey_dismissa pa ìwádìí dé láìsí ìdáhùnsurvey, step, session

Nígbà tí afárá GTM bá ń ṣiṣẹ́, ìṣẹ̀lẹ̀ kan náà tún ń lọ sínú dataLayer (mp_exit_risk àti bẹ́ẹ̀ bẹ́ẹ̀ lọ). MousePlayer.exitRisk() ń dá ewu ìjáde lọ́wọ́lọ́wọ́ padà, tàbí null kí a tó mọ̀ ọ́.

8. Attribute 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 (tàbí class mp-masked): a rọ́pò ọ̀rọ̀ àti ìmúwọlé inú ohun náà kí wọ́n tó kúrò nínú aṣàwákiri — nínú àwòrán ojú ìwé, nínú àyípadà àti nínú àpèjúwe ìtẹ̀.
  • data-mp-ignore (tàbí mp-ignore) lórí pápá fọ́ọ̀mù: a kò gbàsílẹ̀ iye rẹ̀ rárá.
  • data-mp-role: ọ̀kan nínú 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. A kò lo iye mìíràn.

9. Yíyọ ìbẹ̀wò tiyín kúrò

Ẹ ṣí ojúlé yín lẹ́ẹ̀kan pẹ̀lú ?mp_exclude=1 a kò sì gbàsílẹ̀ aṣàwákiri yìí mọ́; ?mp_exclude=0 ń fagilé e. Fún gbogbo nẹ́tíwọ́ọ̀kì ọ́fíìsì, ẹ kọ àdírẹ́sì IP sínú ètò iṣẹ́ akanṣe dípò rẹ̀.

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. Ìjápọ̀ fún òfin àṣírí yín

Àlejò lè rí kí wọ́n sì pa ohun tí a gbàsílẹ̀ nípa wọn rẹ́. privacyUrl() ń dá ìjápọ̀ tí a ti ṣe tán pẹ̀lú ID aṣàwákiri yìí padà — tàbí null bí kò bá sí ọ̀kan, nítorí láìsí ìfọwọ́sí a kò gbàsílẹ̀ ohunkóhun.

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