דלג לתוכן הראשי

התקנה

מדריך זה מסביר כיצד להתקין ולהטמיע את ה-MSQ Pixel SDK באתר שלכם.

שלב 1: הוספת הסקריפט​

הוסיפו את הסקריפט הבא לאתר שלכם, רצוי בחלק ה-<head> של הדף:

<script id="msq_pixel_id" async type="text/javascript"
  src="https://s3.eu-central-1.amazonaws.com/maskyoo-cdn/msq_pixel_2024.js?setting_disable_autorun=true">
</script>

הוספה דינמית באמצעות JavaScript​

ניתן גם להוסיף את הסקריפט באופן דינמי:

var a = document.createElement("script");
a.type = "text/javascript";
a.async = true;
a.id = 'msq_pixel_id';
a.src = "https://s3.eu-central-1.amazonaws.com/maskyoo-cdn/msq_pixel_2024.js?setting_disable_autorun=true";
var b = document.getElementsByTagName("script")[0];
b.parentNode.insertBefore(a, b);

שלב 2: פרמטרים ב-URL​

הפרמטרים הבאים ניתנים להוספה ל-URL של הסקריפט (פרמטרים ב-URL גוברים על ערכים זהים ב-msq_pixel_settings). זהו גם הפורמט שאשף מעקב השיחות באתר מייצר במצב ללא כללים:

פרמטרתיאור
setting_api_keyמזהה החשבון (מפתח API) לזיהוי הלקוח — חובה
setting_pixel_idמזהה החשבון כפי שמופיע בקוד שנוצר על ידי אשף מעקב השיחות (שם חלופי ל-setting_api_key)
setting_disable_autorunמבטל הרצה אוטומטית של הסקריפט. הגדירו ל-true כדי להשבית
setting_run_rulesמריץ את כללי msq_phone_replace_rules מיד לאחר האתחול
setting_async_code_runDeprecated — שם ישן של setting_run_rules. עדיין נתמך
setting_wait4asyncשולט בהמתנה לסקריפטים אסינכרוניים של Google (true כברירת מחדל)
setting_ignore_cookiesאם true, מתעלם מ-cookies (GA4 / Facebook)
setting_ga4_tidמזהה/י GA4 (פסיקים להפרדה)
setting_debugהפעלת מצב debug בקונסול
setting_debug_ga4_tidמזהה GA4 לשליחת אירועי debug
setting_retry_load_intervalמרווח ניסיון חוזר לטעינת סקריפטים (ms)
setting_delay_loadעיכוב לפני תחילת טעינה (ms)
setting_fbq_retry_delayמרווח זיהוי Facebook Pixel (ms)
setting_default_maskyooמספר ברירת מחדל לפיקסל
setting_dn_staticהגדרות מספר דינמי (נוצר באשף) — מספר סטטי לגיבוי
setting_dn_intervalהגדרות מספר דינמי (נוצר באשף) — מרווח סקירה (ms)
setting_dn_timeoutהגדרות מספר דינמי (נוצר באשף) — זמן קצוב לבקשה (ms)

ניתן להוסיף גם פרמטרים מותאמים אישית — הם נכתבים אוטומטית ל-properties של הפיקסל.

שלב 3: הגדרת משתנים​

הגדירו את משתנה ההגדרות הגלובלי לפני טעינת הסקריפט. הסקריפט מאתחל אוטומטית את האובייקט הגלובלי window.msq_pixel (מופע של המחלקה MSQ):

var msq_pixel_settings = {
  setting_api_key: 'YOUR_API_KEY',
  setting_default_maskyoo: '0776670000',
  setting_ga4_tid: 'G-XXXXXXXXXX'
};
אתחול ידני (אופציונלי)

ברוב המקרים אין צורך — הסקריפט יוצר את המופע לבד. אם נדרש אתחול ידני (לדוגמה, הסקריפט נטען עם setting_disable_autorun=true):

// שם המחלקה הוא MSQ
window.msq_pixel = new MSQ(msq_pixel_settings);

שלב 4: הגדרת כללי החלפה (אופציונלי)​

אם ברצונכם להחליף מספרי טלפון באופן אוטומטי, הגדירו את מערך הכללים:

var msq_phone_replace_rules = [
  {
    function: 'referrer_search_and_replace',
    params: {
      conditions_filter: 'gclid',
      search_for_number: '055-4300000',
      replace_number: '055-4311111',
      maskyoo: '055-4311111'
    }
  }
];

התקנה דרך Google Tag Manager​

שימו לב

התקנה דרך Google Tag Manager פחות מומלצת בגלל עיכובים אפשריים בטעינה. ה-SDK נטען רק לאחר טעינת GTM.

  1. היכנסו ל-Google Tag Manager
  2. צרו Tag חדש מסוג "Custom HTML"
  3. הדביקו את קוד הסקריפט
  4. הגדירו Trigger ל-"All Pages"
  5. פרסמו את השינויים

אימות ההתקנה​

כדי לוודא שההתקנה הצליחה:

  1. הפעילו מצב Debug (ראו פתרון בעיות)
  2. פתחו את Developer Tools בדפדפן
  3. חפשו הודעות המתחילות ב-MSQ בקונסול
  4. בדקו שקריאות רשת ל-analytics.maskyoo.net מחזירות קוד 200

השלבים הבאים​

השפעות על המערכת​

התקנת ה‑SDK היא השלב שממנו האתר מתחיל "לדבר" עם מסקיו:

  • דרישות HTML — נדרשת הוספת snippet לכל העמודים הרלוונטיים; בלי זה הקמפיינים הדינמיים לא יפעלו
  • טעינה אסינכרונית — הסקריפט אסינכרוני ולא חוסם טעינת דף; עלול לרוץ אחרי render ולכן חלק מההחלפות עשויות להתבצע במעט השהיה
  • Google Tag Manager — חלופה קיימת אך פחות מומלצת בגלל עיכובי טעינה של GTM
  • setting_disable_autorun — נטען ללא ריצה; כללים יורצו רק עם הפעלה ידנית או setting_run_rules
  • אבטחה / CSP — ה‑domain של ה‑CDN ושל analytics.maskyoo.net חייבים להיות ב‑Content‑Security‑Policy של האתר
  • אימות התקנה — setting_debug: true מאפשר קריאת לוגים בקונסול לווידוא שהפיקסל נטען ורץ

ראו גם​