JavaScript API

ທຸກສິ່ງທີ່ mp.js ໃຫ້ໂຄດຂອງທ່ານເອງ: ການຍິນຍອມ, ID ລູກຄ້າ, ເຫດການກຳນົດເອງ, ຂັ້ນຕອນທີ່ບໍ່ປ່ຽນທີ່ຢູ່, hook ແລະ HTML attribute. ບໍ່ມີສິ່ງໃດໃນນີ້ຈຳເປັນ - ສະນິບເພັດຢ່າງດຽວກໍບັນທຶກໄດ້.

1. ສອງວິທີເອີ້ນ

mp.js ໂຫຼດແບບບໍ່ຂັດຂວາງ. ໂຄດທີ່ເຮັດວຽກກ່ອນໂຫຼດຈະໃສ່ການເອີ້ນໃນຄິວ window.mp_q; mp.js ຈັດການຄິວທັນທີທີ່ພ້ອມ. ຫຼັງຈາກນັ້ນ ຟັງຊັນດຽວກັນມີໃຫ້ໃນ 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);

ຂຽນ window.mp_q = window.mp_q || [] ສະເໝີ, ຢ່າໃຊ້ window.mp_q = []. mp.js ຟັງອາເຣນັ້ນຕໍ່ໄປ - ອາເຣໃໝ່ຈະກືນທຸກການເອີ້ນພາຍຫຼັງ ລວມທັງການຖອນການຍິນຍອມ.

ສະນິບເພັດຕິດຕັ້ງຍັງກຳນົດຟັງຊັນຊົ່ວຄາວ mp(...) ທີ່ໃສ່ຄິວຄືກັນ. ທັງສອງຮູບແບບຮັບຄຳສັ່ງດຽວກັນ: consent, set, event, step, get, on ແລະ off.

2. ການຍິນຍອມ

ຖ້າບໍ່ຍິນຍອມ ບໍ່ບັນທຶກຫຍັງ. ຖ້າເຄື່ອງມືຍິນຍອມເປັນຕົວທີ່ MousePlayer ຮູ້ຈັກ ທ່ານບໍ່ຕ້ອງໃຊ້ສິ່ງເຫຼົ່ານີ້; ຖ້າບໍ່ ໃຫ້ສົ່ງຕໍ່ການຕັດສິນໃຈເອງ.

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'

ການຖອນມີຜົນທັນທີໃນໜ້າ: ຖອນຕົວຟັງ, ຖິ້ມຂໍ້ມູນບັຟເຟີ, ປິດການເຊື່ອມຕໍ່. ເບິ່ງ MousePlayer ແລະ ການຍິນຍອມ.

3. ID ລູກຄ້າຂອງທ່ານ

ດ້ວຍ ID ຂອງທ່ານເອງ ທຸກອຸປະກອນຂອງຄົນດຽວຈະເປັນຜູ້ເຂົ້າຊົມຄົນດຽວໃນລາຍການ ແລະ ຄົ້ນຫາກໍລະນີຊ່ວຍເຫຼືອດ້ວຍເລກທີ່ຮູ້ໄດ້. ID ຍັງໃຊ້ກັບການເຂົ້າຊົມກ່ອນໜ້າຂອງບຣາວເຊີດຽວກັນໃນ 30 ມື້ທີ່ຜ່ານມາ.

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

ໃຊ້ເລກພາຍໃນ ບໍ່ແມ່ນອີເມວຫຼືຊື່. MousePlayer ສະແດງ ID ໃນທຸກບ່ອນທີ່ຜູ້ເຂົ້າຊົມປາກົດ.

ອ່ານ ID ກັບຄືນ

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. ເຫດການກຳນົດເອງ

ເຫດການທີ່ສົ່ງປາກົດໃນເສັ້ນເວລາຫຼິ້ນຄືນ, ໃຊ້ເປັນເປົ້າໝາຍແລະຂັ້ນຕອນຟັນເນວໄດ້ ແລະ ໄປຫາ webhook ແລະ ເຄື່ອງມືທີ່ເຊື່ອມ. ພາຣາມິເຕີເປັນຄ່າສັ້ນ: ຕົວເລກ, ຂໍ້ຄວາມສູງສຸດ 255 ຕົວອັກສອນ, ຄີສູງສຸດ 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' }]);
  • ຊື່: ຕົວພິມນ້ອຍພ້ອມຂີດລຸ່ມ, ສູງສຸດ 128 ຕົວອັກສອນ. ໃຊ້ຊື່ດຽວກັນສຳລັບສິ່ງດຽວກັນທຸກບ່ອນ - ເປົ້າໝາຍຈັບຄູ່ຊື່ຢ່າງແມ່ນຍຳ.
  • ຢ່າໃສ່ຂໍ້ມູນສ່ວນບຸກຄົນໃນພາຣາມິເຕີ. ມັນຖືກເກັບແລະສະແດງຄືເຫດການອື່ນ.

5. ຂັ້ນຕອນທີ່ບໍ່ປ່ຽນທີ່ຢູ່

ຂັ້ນຕອນຊຳລະເງິນ ຫຼື ຕົວຊ່ວຍທີ່ປ່ຽນໜ້າຈໍແຕ່ບໍ່ປ່ຽນທີ່ຢູ່ ເປັນໜ້າດຽວສຳລັບ MousePlayer. step() ເຮັດໃຫ້ແຕ່ລະໜ້າຈໍເປັນການເບິ່ງໜ້າຂອງຕົນເອງ - ມີພາບໜ້າ, ແຖວແຜນທີ່ຄວາມຮ້ອນ ແລະ ຂັ້ນຕອນຟັນເນວສະເພາະ.

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

ຊື່ຍາວ 1 ຫາ 40 ຕົວອັກສອນຈາກ a-z, 0-9, _ ແລະ -; ຊ່ອງວ່າງກາຍເປັນຂີດ, ສິ່ງອື່ນຖືກປະຕິເສດພ້ອມຄຳເຕືອນໃນຄອນໂຊນ. ການນຳທາງຈິງສິ້ນສຸດຂັ້ນຕອນ.

6. ບໍລິບົດສິນຄ້າ

ໃນໜ້າສິນຄ້າ ແຈ້ງ MousePlayer ວ່າກຳລັງເບິ່ງຫຍັງ. ຮັບພຽງຄີເຫຼົ່ານີ້; ຖິ້ມສິ່ງອື່ນທັງໝົດເພື່ອບໍ່ໃຫ້ຂໍ້ມູນລູກຄ້າຫຼຸດເຂົ້າມາໂດຍບັງເອີນ.

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

ໂຄດຂອງທ່ານຕອບສະໜອງຕໍ່ສິ່ງທີ່ MousePlayer ວັດໃນໜ້າໄດ້. ລົງທະບຽນຜ່ານຄິວຖ້າ 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);
ຊື່ເມື່ອຊ່ອງ
exit_riskໂມເດວການອອກໃຫ້ຄະແນນການເບິ່ງໜ້າທຳອິດແລ້ວ (ຄັ້ງດຽວຕໍ່ການເຂົ້າຊົມ)risk, reasons, session
churn_riskໝາຍຜູ້ເຂົ້າຊົມທີ່ກັບມາວ່າມີແນວໂນ້ມຈະບໍ່ກັບມາອີກrisk, reasons, session
offer_shownສະແດງຂໍ້ສະເໜີເມື່ອຈະອອກart, risk, grund, session
offer_clickຄລິກປຸ່ມຂອງມັນart, risk, grund, session, fehler
offer_dismissປິດມັນart, risk, grund, session
survey_shownເປີດແບບສຳຫຼວດsurvey, trigger, session
survey_answerຜູ້ເຂົ້າຊົມຕອບsurvey, type, value, option, sentiment, session
survey_textສົ່ງຂໍ້ຄວາມຕິດຕາມ (ກອງແລ້ວ)survey, text, session
survey_dismissປິດແບບສຳຫຼວດໂດຍບໍ່ຕອບsurvey, step, session

ເມື່ອເປີດຂົວເຊື່ອມ GTM ເຫດການດຽວກັນຍັງໄປ dataLayer (mp_exit_risk ແລະ ອື່ນໆ). MousePlayer.exitRisk() ສົ່ງຄືນຄວາມສ່ຽງທີ່ຈະອອກປັດຈຸບັນ ຫຼື null ກ່ອນຈະຮູ້ຄ່າ.

8. HTML attribute

<!-- 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 (ຫຼື class mp-masked): ຂໍ້ຄວາມແລະຂໍ້ມູນປ້ອນໃນອົງປະກອບຖືກແທນກ່ອນອອກຈາກບຣາວເຊີ - ໃນພາບໜ້າ, ການປ່ຽນແປງ ແລະ ຄຳອະທິບາຍຄລິກ.
  • data-mp-ignore (ຫຼື mp-ignore) ໃນຊ່ອງຟອມ: ບໍ່ບັນທຶກຄ່າຂອງມັນເລີຍ.
  • 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. ບໍ່ສົນໃຈຄ່າອື່ນ.

9. ຍົກເວັ້ນການເຂົ້າຊົມຂອງທ່ານເອງ

ເປີດເວັບໄຊຄັ້ງດຽວດ້ວຍ ?mp_exclude=1 ແລ້ວບຣາວເຊີນີ້ຈະບໍ່ຖືກບັນທຶກອີກ; ?mp_exclude=0 ຍົກເລີກມັນ. ສຳລັບທັງເຄືອຂ່າຍສຳນັກງານ ໃຫ້ປ້ອນ 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. ລິ້ງສຳລັບນະໂຍບາຍຄວາມເປັນສ່ວນຕົວ

ຜູ້ເຂົ້າຊົມສາມາດເບິ່ງແລະລຶບສິ່ງທີ່ບັນທຶກກ່ຽວກັບຕົນເອງ. privacyUrl() ສົ່ງຄືນລິ້ງສຳເລັດຮູບພ້ອມ ID ຂອງບຣາວເຊີນີ້ - ຫຼື null ຖ້າບໍ່ມີ ເພາະບໍ່ໄດ້ບັນທຶກຫຍັງໂດຍບໍ່ຍິນຍອມ.

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