JavaScript API

mp.js таны кодод өгдөг бүх зүйл: зөвшөөрөл, таны харилцагчийн ID, тусгай үйл явдал, хаяг өөрчлөхгүй алхам, холбогч функцүүд болон HTML шинжүүд. Эндээс юу ч заавал хэрэггүй. Кодын хэсэг дангаараа бичлэг хийнэ.

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. Холбогч функцүүд

Таны код MousePlayer хуудсанд хэмжсэн зүйлд хариу үйлдэл үзүүлж болно. Холбогч эхний агшныг алдах ёсгүй бол дарааллаар бүртгэнэ үү.

// 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 шинжүүд

<!-- 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 (эсвэл дараах класс 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-тай бэлэн холбоос буцаана. Зөвшөөрөлгүйгээр юу ч бүртгээгүйгээс ID байхгүй бол null буцаана.

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