API JavaScript - MousePlayer

1. Ụzọ abụọ isi kpọọ ya

mp.js na-ebu n'enweghị igbochi ọrụ ndị ọzọ. Koodu na-arụ tupu o buo na-etinye oku ya n'ahịrị window.mp_q; mp.js na-arụcha ha ozugbo ọ bịara. Mgbe nke ahụ gasịrị, otu ọrụ ndị ahụ dị na 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);

Na-ede mgbe niile window.mp_q = window.mp_q || [], edela mgbe ọ bụla window.mp_q = []. mp.js na-anọgide na-ege array ahụ ntị — nke ọhụrụ ga-eloda oku niile e mesịrị, tinyere iwepụ nkwenye.

Iberibe koodu nrụnye na-akọwakwa stub mp(...) nke na-etinye n'ahịrị n'otu ụzọ ahụ. Ụdị abụọ ahụ na-anabata otu iwu: consent, set, event, step, get, on na off.

2. Nkwenye

Enweghị nkwenye, a naghị edekọ ihe ọ bụla. Ọ bụrụ na ngwa nkwenye gị so na ndị MousePlayer na-amata, ị chọghị ihe ọ bụla n'ime nke a; ma ọ bụghị ya, nyefee mkpebi ahụ n'onwe gị.

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'

Iwepụ nkwenye na-arụ ọrụ n'ibe ozugbo: a na-ewepụ ndị na-ege ntị, tụfuo data dị na buffer, mechie njikọ. Lee MousePlayer na nkwenye.

3. ID onye ahịa gị

Site na ID nke gị, ngwaọrụ niile nke otu onye na-aghọ otu onye ọbịa na ndepụta, ị nwere ike ịchọ nsogbu enyemaka site na nọmba ị maara. A na-etinyekwa ID ahụ na nleta gara aga nke otu ihe nchọgharị ahụ site na ụbọchị 30 gara aga.

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

Jiri nọmba ime, ọ bụghị adreesị email ma ọ bụ aha. MousePlayer na-egosi ID ebe ọ bụla onye ọbịa pụtara.

Ịgụghachi 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. Ihe omume nke gị

Ihe omume ị na-eziga na-apụta na usoro oge ịkpọgharị, ha nwere ike ịbụ ebumnuche na nzọụkwụ ọwara, ha na-agakwa na webhook na ngwa ejikọrọ gị. Paramita bụ uru dị mkpụmkpụ: nọmba, string ruru mkpụrụedemede 255, igodo ruru mkpụrụedemede 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' }]);

Aha: mkpụrụedemede nta na underscore, kacha mkpụrụedemede 128. Jiri otu aha maka otu ihe n'ebe niile — ebumnuche na-adakọ aha kpọmkwem.
Etinyela data nkeonwe na paramita. A na-echekwa ma gosipụta ha dịka ihe omume ọ bụla ọzọ.

5. Nzọụkwụ na-enweghị mgbanwe adreesị

Usoro ịkwụ ụgwọ ma ọ bụ ọkachamara na-agbanwe ihuenyo ya ma ọ bụghị adreesị ya bụ otu ibe nye MousePlayer. step() na-eme ka ihuenyo ọ bụla bụrụ nlele ibe nke ya — nwere onyonyo ibe, ahịrị maapụ okpomọkụ na nzọụkwụ ọwara nke ya.

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

Aha nwere mkpụrụedemede 1 ruo 40 sitere na a-z, 0-9, _ na -; oghere na-aghọ hyphen, a na-ajụ ihe ọ bụla ọzọ na ịdọ aka ná ntị na console. Ịgafe ibe n'ezie na-emechi nzọụkwụ ahụ.

6. Ihe gbasara ngwaahịa

N'ibe ngwaahịa, gwa MousePlayer ihe a na-ele. Naanị igodo ndị a ka a na-anabata; a na-atụfu ihe ọ bụla ọzọ ka data onye ahịa ghara ịbanye na mberede.

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

Koodu gị nwere ike ịzaghachi ihe MousePlayer na-atụ n'ibe. Debanye site n'ahịrị ma ọ bụrụ na hook agaghị atụfu oge mbụ.

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

Aha	Mgbe	Oghere
`exit_risk`	ụdị ịpụ enyela nlele ibe mbụ akara (otu ugboro n'otu nleta)	`risk, reasons, session`
`churn_risk`	a kara onye ọbịa lọghachiri dịka onye nwere ike ịghara ịlọghachi	`risk, reasons, session`
`offer_shown`	a na-egosi onyinye ịpụ	`art, risk, grund, session`
`offer_click`	a pịrị bọtịnụ ya	`art, risk, grund, session, fehler`
`offer_dismiss`	a mechiri ya	`art, risk, grund, session`
`survey_shown`	nyocha ajụjụ meghere	`survey, trigger, session`
`survey_answer`	onye ọbịa zara	`survey, type, value, option, sentiment, session`
`survey_text`	e zigara ederede na-esote (e zachalarị)	`survey, text, session`
`survey_dismiss`	e mechiri nyocha ajụjụ n'enweghị azịza	`survey, step, session`

Mgbe àkwà njikọ GTM gbanyere, otu ihe omume ndị ahụ na-agakwa n'ime dataLayer (mp_exit_risk na ihe ndị ọzọ). MousePlayer.exitRisk() na-eweghachite ihe ize ndụ nke ịpụ ugbu a, ma ọ bụ null tupu a mata ya.

8. Njirimara HTML

<section data-mp-mask> ... </section>  <input name="voucher" data-mp-ignore>  <span class="amount" data-mp-role="price">89,90 EUR</span>

data-mp-mask (ma ọ bụ klaasị mp-masked): a na-anọchi ederede na ntinye dị n'ime ihe ahụ tupu ha apụ n'ihe nchọgharị — n'onyonyo ibe, n'ime mgbanwe na nkọwa ọpịpị.
data-mp-ignore (ma ọ bụ mp-ignore) n'oghere fọm: a naghị edekọ uru ya ma ọlị.
data-mp-role: otu n'ime 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 na-eleghara uru ndị ọzọ anya.

9. Iwepụ nleta nke gị

Mepee webụsaịtị gị otu ugboro na ?mp_exclude=1 a naghịzi edekọ ihe nchọgharị a; ?mp_exclude=0 na-eweghachi ya. Maka netwọk ụlọ ọrụ dum, tinye adreesị IP na ntọala ọrụ ngo kama ya.

https://www.your-shop.com/?mp_exclude=1  https://www.your-shop.com/?mp_exclude=0

10. Njikọ maka amụma nzuzo gị

Ndị ọbịa nwere ike ịhụ ma hichapụ ihe e dekọrọ gbasara ha. privacyUrl() na-eweghachite njikọ dị njikere nwere ID ihe nchọgharị a — ma ọ bụ null ma ọ bụrụ na nke adịghị, n'ihi na enweghị nkwenye, a naghị edekọ ihe ọ bụla.

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

Kedu ka anyị nwere ike isi nyere gị aka?