JavaScript API - MousePlayer

1. Divi izsaukšanas veidi

mp.js ielādējas asinhroni. Kods, kas darbojas pirms tā ielādes, ievieto izsaukumus rindā window.mp_q; mp.js tos apstrādā, tiklīdz ir pieejams. Pēc tam tās pašas funkcijas ir pieejamas objektā 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);

Vienmēr rakstiet window.mp_q = window.mp_q || [], nekad window.mp_q = []. mp.js turpina klausīties šo masīvu — jauns masīvs aprītu katru turpmāko izsaukumu, ieskaitot piekrišanas atsaukšanu.

Instalēšanas koda fragments definē arī aizstājējfunkciju mp(...), kas tāpat ievieto izsaukumus rindā. Abas formas pieņem tās pašas komandas: consent, set, event, step, get, on un off.

2. Piekrišana

Bez piekrišanas nekas netiek ierakstīts. Ja jūsu piekrišanas rīks ir starp tiem, ko MousePlayer atpazīst, nekas no šā nav vajadzīgs; citādi nododiet lēmumu paši.

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'

Atsaukšana lapā stājas spēkā uzreiz: klausītāji tiek noņemti, buferī esošie dati atmesti, savienojums aizvērts. Skatiet MousePlayer un piekrišana.

3. Jūsu klienta ID

Ar jūsu pašu ID visas vienas personas ierīces sarakstos kļūst par vienu apmeklētāju, un atbalsta gadījumu varat meklēt pēc zināmā numura. ID tiek piemērots arī tās pašas pārlūkprogrammas agrākajiem apmeklējumiem pēdējo 30 dienu laikā.

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

Izmantojiet iekšēju numuru, nevis e-pasta adresi vai vārdu. MousePlayer rāda ID visur, kur parādās apmeklētājs.

ID nolasīšana

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. Pielāgoti notikumi

Jūsu sūtītie notikumi parādās atskaņojuma laika skalā, var būt mērķi un piltuves soļi un nonāk jūsu tīmekļa aizķerēs un savienotajos rīkos. Parametri ir īsas vērtības: skaitļi, virknes līdz 255 rakstzīmēm, atslēgas līdz 64 rakstzīmēm.

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

Nosaukumi: mazie burti ar pasvītrām, ne vairāk kā 128 rakstzīmes. Vienai lietai visur lietojiet to pašu nosaukumu — mērķis salīdzina nosaukumus precīzi.
Nelieciet parametros personas datus. Tie tiek glabāti un parādīti tāpat kā jebkurš cits notikums.

5. Soļi bez adreses maiņas

Norēķināšanās vai vednis, kas maina ekrānu, bet ne adresi, MousePlayer izpratnē ir viena lapa. step() padara katru ekrānu par atsevišķu lapas skatījumu — ar savu momentuzņēmumu, siltumkartes rindu un piltuves soli.

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

Nosaukums ir no 1 līdz 40 rakstzīmēm no a-z, 0-9, _ un -; atstarpes kļūst par defisēm, viss pārējais tiek noraidīts ar brīdinājumu konsolē. Īsta navigācija beidz soli.

6. Produkta konteksts

Produkta lapā paziņojiet MousePlayer, kas tiek skatīts. Tiek pieņemtas tikai šīs atslēgas; viss pārējais tiek atmests, lai nejauši neiekļūtu klientu dati.

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. Aizķeres

Jūsu kods var reaģēt uz to, ko MousePlayer mēra lapā. Reģistrējiet caur rindu, ja aizķere nedrīkst palaist garām pirmo brīdi.

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

Nosaukums	Kad	Lauki
`exit_risk`	aiziešanas modelis ir novērtējis pirmo lapas skatījumu (vienreiz apmeklējumā)	`risk, reasons, session`
`churn_risk`	atkārtotam apmeklētājam atzīmēts iespējams zaudēšanas risks	`risk, reasons, session`
`offer_shown`	tiek parādīts aiziešanas piedāvājums	`art, risk, grund, session`
`offer_click`	uz tā pogas tiek noklikšķināts	`art, risk, grund, session, fehler`
`offer_dismiss`	tas tiek aizvērts	`art, risk, grund, session`
`survey_shown`	tiek atvērta aptauja	`survey, trigger, session`
`survey_answer`	apmeklētājs atbild	`survey, type, value, option, sentiment, session`
`survey_text`	tiek nosūtīts papildu teksts (jau filtrēts)	`survey, text, session`
`survey_dismiss`	aptauja tiek aizvērta bez atbildes	`survey, step, session`

Kad GTM tilts ir ieslēgts, tie paši notikumi nonāk arī dataLayer (mp_exit_risk un tā tālāk). MousePlayer.exitRisk() atgriež pašreizējo aiziešanas risku vai null, pirms tas ir zināms.

8. HTML atribūti

<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 (vai klase mp-masked): teksts un ievade elementā tiek aizstāti, pirms tie atstāj pārlūku — momentuzņēmumā, izmaiņās un klikšķu aprakstos.
data-mp-ignore (vai mp-ignore) veidlapas laukā: tā vērtība vispār netiek ierakstīta.
data-mp-role: viena no vērtībām 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. Pārējās vērtības tiek ignorētas.

9. Savu apmeklējumu izslēgšana

Vienreiz atveriet savu vietni ar ?mp_exclude=1, un šis pārlūks vairs netiek ierakstīts; ?mp_exclude=0 to atceļ. Visam biroja tīklam tā vietā ievadiet IP adreses projekta iestatījumos.

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

10. Saite jūsu privātuma politikai

Apmeklētāji var redzēt un dzēst par viņiem ierakstīto. privacyUrl() atgriež gatavu saiti ar šā pārlūka ID vai null, ja tāda nav, jo bez piekrišanas nekas netika ierakstīts.

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

Kā varam palīdzēt?