אימות היטים - Measurement Protocol

במסמך הזה נסביר איך מאמתים היטים של פרוטוקול מדידה ב-Google Analytics.

סקירה

ה-Measurement Protocol של Google Analytics לא מחזיר קודי שגיאה של HTTP, גם אם היט של Measurement Protocol שגוי או אם חסרים לו פרמטרים נדרשים. כדי לוודא שההיטים מופיעים בפורמט הנכון ומכילים את כל הפרמטרים הנדרשים, אפשר לבדוק אותם מול שרת האימות לפני פריסתם בסביבת הייצור.

במדריך הזה מתואר תהליך שליחת היטים לשרת האימות של פרוטוקול המדידה, ונסביר איך לפרש את התגובה.

שליחת היטים לאימות

ניתן לשלוח היטים לשרת האימות של Measurement Protocol באמצעות כל שיטה שנתמכת כרגע על ידי Measurement Protocol. ההבדל היחיד הוא כתובת ה-URL. כדי לשלוח היטים לשרת האימות של Measurement Protocol, צריך להשתמש בנקודת הקצה /debug/collect במקום ב-/collect. בדוגמה הבאה מוצגת היט לא חוקי שנשלח לשרת האימות של Measurement Protocol:

https://www.google-analytics.com/debug/collect?tid=fake&v=1

לפרטים נוספים על יצירת היט של Measurement Protocol, אפשר לעיין בחומר העזר בנושא פרוטוקול.

פירוש התגובה

התשובות משרת האימות של Measurement Protocol יהיו בפורמט JSON. בדוגמה הבאה מוצגת התגובה להיט שהוצג למעלה:

{
  "hitParsingResult": [
    {
      "valid": false,
      "hit": "GET /debug/collect?tid=fake\u0026v=1 HTTP/1.1",
      "parserMessage": [
        {
          "messageType": "ERROR",
          "description": "The value provided for parameter 'tid' is invalid. Please see http://goo.gl/a8d4RP#tid for details.",
          "parameter": "tid"
        },
        {
          "messageType": "ERROR",
          "description": "Tracking Id is a required field for this hit. Please see http://goo.gl/a8d4RP#tid for details.",
          "parameter": "tid"
        }
      ]
    }
  ]
}

השורש של התגובה, hitParsingResult, הוא מערך שהאורך שלו יהיה תואם למספר ההיטים שנשלחו בבקשה המקורית. כל אובייקט במערך יכיל את המפתחות valid, hit ו-parserMessage. במקרה של היט לא תקין, parserMessage יכיל מערך של אובייקטים שמתארים את בעיות האימות. אם היט תקין, parserMessage יהיה מערך ריק.

בטבלה הבאה מתוארים המאפיינים של כל פריט במערך hitParsingResult:

מפתח	סוג	תיאור
`valid`	`Boolean`	`true` להיטים חוקיים, `false` להיטים לא חוקיים.
`hit`	`string`	מחרוזת שמכילה את הנתיב של הבקשה וגם את השיטה והפרוטוקול שלה.
`parserMessage`	`Array`	רשימת הודעות של מנתח. אם ההתאמה חוקית, המערך הזה יהיה ריק.
`parserMessage.messageType`	`string`	ערכים אפשריים הם "INFO", "WARN" ו-"ERROR".
`parserMessage.description`	`string`	פרטים נוספים או שלבים לפתרון הבעיה באימות.
`parserMessage.parameter`	`string\|undefined`	הפרמטר (אם רלוונטי) שגורם לבעיית האימות.