מעקב אחר גאדג'טים

מסמך זה מתאר כיצד להשתמש בממשק ה-API של הגאדג'ט החדש לצורך מעקב אחר גאדג'טים של Analytics. ממשק API זה מציע מודל נתונים משופר ומעקב ביצועים, כדי לאסוף נתונים סטטיסטיים של דוחות Analytics עבור הגאדג'טים שלכם.

  1. לפני שמתחילים
  2. מעקב אחר הגאדג'ט
  3. שיטות מעקב
  4. שיקולים לשימוש
  5. טיפים
 

לפני שתתחיל

ב-Google Analytics, מתבצע מעקב אחרי כל דומיין אתר או תת-דומיין ייחודי שאתה מוסיף לחשבון בתצוגה מפורטת (פרופיל) נפרדת ולהקצות לו מזהה דומיין נפרד. מכיוון שכל גאדג'ט פועל על תת-דומיין משלו באתר המארח של gmodules.com, תרצו לעקוב אחר כל גאדג'ט שאתם יוצרים בתצוגה (פרופיל) משלו ועם מזהה דומיין ייחודי.

הדרך הפשוטה ביותר לעשות זאת היא לאפשר ל-Google Analytics ליצור עבורך מזהה ייחודי.

  1. כדי להתחיל, נכנסים ל-Google Analytics או נרשמים לחשבון Google Analytics.
    • משתמשים חדשים אמורים לראות את הדף הרשמה לחשבון חדש.
    • משתמשים קיימים צריכים להיכנס לדף הגדרות Analytics וללחוץ על הוספת תצוגה מפורטת של אתר (פרופיל). (חשוב לבחור דומיין חדש.)
  2. בכל אחד מהדפים האלה, יש להזין כל כתובת אתר חוקית.
    3. כתובת האתר היא רק מחרוזת שהתוכנה של Google Analytics מתאימה למזהה הדומיין שלך, ולכן כתובת ה-URL הזו יכולה להיות כל מחרוזת חוקית של כתובת אתר, גם אם היא מפוברקת וגם אם היא אמיתית. לא תתקין את קוד המעקב בדפי אינטרנט כלל, ולא תצטרך גישה לדפי אינטרנט כלשהם.
  3. יש ללחוץ על הלחצן כדי להמשיך למסך הבא.
    4. כשקטע קוד המעקב מופיע, מעתיקים את מזהה הדומיין הייחודי למשטח הגירוד. קטע הקוד שנוצר באופן אוטומטי מכיל את מזהה הדומיין הזה בצורת UA-123456-1.
  4. לוחצים על הלחצן סיום.
    5. השם של כתובת האתר שלכם אמור להופיע ברשימת התצוגות המפורטות (הפרופיל). אפשר גם לשנות את שם התצוגה המפורטת (פרופיל) לשם משמעותי יותר. לשם כך, לוחצים על הקישור עריכה עבור התצוגה המפורטת הזו (פרופיל), ולאחר מכן לוחצים שוב על עריכה.
  5. בקוד המעקב של הגאדג'ט משתמשים במזהה הדומיין שנוצר.
    6. מזהי דומיינים ב-Analytics מופיעים בפורמט:
    UA-123456-1
 

מעקב אחר הגאדג'ט שלך

תהליך המעקב אחר הגאדג'ט שלך כולל שלוש תוספות לקוד הגאדג'ט:

  1. הפעלת התכונה.
  2. יצירת אובייקט מעקב.
  3. מעקב אחר הגאדג'ט באחת משתי שיטות.

דוגמת קוד הגאדג'ט הבאה מציגה כל אחת מתוספות הקוד האלו, כפי שמוסבר בהמשך. תוכל להשתמש בקובץ לדוגמה כדי להפעיל גאדג'ט משלך.

<?xml version="1.0" encoding="UTF-8" ?>
<Module>
  <ModulePrefs title="Analytics Test">
     <!-- Sets the feature -->
     <Require feature="com.google.gadgets.analytics" /> 
     <Require feature="setprefs" /> 
  </ModulePrefs>
  <UserPref 
      name="counter"
      datatype="hidden"
      default_value="0" />
  <Content type="html"> 
  <![CDATA[ 
      <script>
      // Track this gadget using Google Analytics.

      // Creates a tracking object and uses reportPageview method to call gadget view
      var ga = new _IG_GA("UA-00000-1");
      ga.reportPageview('/view/counterGadget');

      // Suppose, for example, you have a gadget with two counter buttons.
      // You can track interactions with those counters via Analytics.

      // Increment value of "counter" user preference
      function incrementCounter() {
         var count = prefs.getInt("counter");

         prefs.set("counter", count + 1);

         // Tracks button click as an event
         ga.reportEvent("Counter Gadget", "Increment", "Button", 0);
      }

      // Reset value of "counter" userpref to 0
      function resetCounter(){
         prefs.set("counter", 0);

         // Tracks button click as an event
         ga.reportEvent("Counter Gadget", "Reset", "Button", 0);
      }
      </script>
      <form name="counter">
      <input type=button value="Reset" name="reset" onClick="resetCounter()">
      <input type=button value="Count" name="count" onClick="incrementCounter()">
      </form>
  ]]>
  </Content>
</Module>

‫1. הפעלת התכונה

תחילה, מפעילים את התכונה על ידי ייבוא ספריית Analytics באמצעות מרחב השמות של התכונות:

 <Require feature="com.google.gadgets.analytics" />

2. יצירת אובייקט מעקב

ה-API למעקב של Analytics פועל בהתאם לאותו מודל מוכוון-אובייקטים של קוד המעקב ga.js. לכן, לפני שתעקוב אחר הגאדג'ט שלך, צור אובייקט מעקב:

var ga = new _IG_GA("UA-123456-1");

כאן מזינים את מזהה הדומיין שנוצר על ידי ביצוע השלבים שלמעלה.

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

3. מעקב אחר הגאדג'ט שלך

ממשק ה-API של הגאדג'ט מספק שתי שיטות למעקב אחר אינטראקציה עם הגאדג'טים שלך:

  • השיטה של כתובת ה-URL הווירטואלית
    • ga.reportPageview(path);

    שיטה זו עוקבת אחר נתונים סטטיסטיים של גאדג'טים כתצוגות דף מיוחדות, והיא אותה שיטה שבה נעשה שימוש בגרסה הקודמת של ממשק ה-API של הגאדג'ט של Analytics. באמצעות שיטה זו, אפשר לעדכן כל קוד מעקב של גאדג'ט שכבר קיים, מבלי להשפיע על פריסת הדוחות הקיימים ב-Analytics. אתה מציג נתוני דיווח בגאדג'טים שלך בדיוק כמו שאתה מציג נתוני דיווח של דפי אינטרנט.

    כאשר אתה משתמש בשיטת כתובת האתר הווירטואלית כדי לעקוב אחר אינטראקציה עם גאדג'ט, כל קריאה מתועדת כבקשת דף עבור המחרוזת שאתה מספק כפרמטר לשיטה. ניתן לנצל את ההתנהגות הזו כדי להעביר נתיב מפובר של כתובת אתר, וכך להציג דוחות עבור גאדג'טים בממשק של Google Analytics, בדיוק כמו דוחות של דפי אתר. לדוגמה, אפשר להשתמש בנתיבים נפרדים כדי לעקוב גם אחרי תצוגות גאדג'טים וגם אחר אינטראקציות עם גאדג'טים: 

    ga.reportPageview('/view/counterGadget');
ga.reportPageview('/click/increment');
ga.reportPageview('/click/reset');

  • שיטת המעקב אחר אירועים
    • ga.reportEvent(name, action, [[]label], [[]value]);

    השיטה הזו זמינה רק בממשק ה-API של הגאדג'ט החדש של Analytics. באמצעות שיטה זו, ניתן לעקוב אחר צפיות בדף (לדוגמה, עיבוד גאדג'ט) בנפרד מאינטראקציות של משתמשים עם הגאדג'ט שלך.

    הערה: נכון לעכשיו, התכונה 'מעקב אחר אירועים' נמצאת בגרסת בטא סגורה. אם אין לכם גישה למעקב אחר אירועים, השתמשו בשיטה של כתובת URL וירטואלית.

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

    בהמשך לדוגמת המונים, אנחנו יכולים להשתמש בשיטת האירוע כדי לעקוב אחר פונקציות הגאדג'ט שמופעלות, ולהעביר את סוג הבקרה, שהוא לחצן בשני המקרים. 

    ga.reportEvent("Counter Gadget", "Increment", "Button");
ga.reportEvent("Counter Gadget", "Reset", "Button");

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

 

שיטות מעקב

בשלב זה, התכונה Analytics מציעה את השיטות הבאות. הסברנו למעלה על השימוש שלהם.

  • reportPageview()
    • נדרשת מחרוזת כדי לאכלס את דוחות התוכן בצורה תקינה. בדרך כלל המחרוזת הזו היא בצורת נתיב שאתם מגדירים למטרות הדיווח. הערך שמועבר לשיטה הזו נשלח בבקשה GIF באמצעות המשתנה utmp. השתמש בשיטה זו כדי לעקוב אחר טעינות של גאדג'טים ואינטראקציות עם גאדג'טים. 
    ga.reportPageview("/view/gadgetName");
    פרמטרים
    String  path נתיב לכתובת ה-URL הווירטואלית של הרכיב הזה.

  • reportEvent()
    • כדי להוסיף נתונים במעקב לדוחות של 'מעקב אחר אירועים', השם של הגאדג'ט והפרמטר של הפעולה נדרשים. שאר הפרמטרים הם אופציונליים. הערכים שמועברים בשיטה הזו נשלחים בתצוגת הבקשה GIF במשתנה utme.

    פרמטרים
    String  name  חובה.מחרוזת שמשמשת ברמה העליונה של הדוחות 'מעקב אחר אירועים'. לדוגמה, אם אתם עוקבים אחר אינטראקציה במספר אלמנטים של גאדג'ט, סביר להניח שתשתמשו בשם של הגאדג'ט עצמו עבור הפרמטר הזה, כך שכל המעקב אחר אינטראקציות של הגאדג'ט יופיע באותו קטע בדוחות של Google Analytics.

    String  action  חובה. מחרוזת לפילוח נוסף של אינטראקציה עם גאדג'ט בדוחות של מעקב אחר אירועים. מידע נוסף זמין במאמר בנושא אירועי מעקב.

    String  label  אופציונלי. מחרוזת שבה ניתן להשתמש כפלח משני של הגאדג'ט.

    Int  value  אופציונלי. מספר שניתן לציין כערך עבור האינטראקציה עם הגאדג'ט. המספר הזה נצבר בכל פעם שהשיטה מופעלת.

 

שיקולים לשימוש

ממשק ה-API לגאדג'ט של Google Analytics מסתמך על מספר שיקולים בנוגע לשימוש:

  • מאגרים נתמכים
    • הרבה סוגים של קונטיינרים נתמכים ב-API של הגאדג'ט של Google Analytics, כולל, בין היתר:
    • iGoogle
    • הפצה פתוחה
    • Open Social
    • גאדג'טים
  • סוגי גאדג'טים שלא נתמכים
    • ממשק ה-API של הגאדג'ט של Google Analytics לא תומך בגאדג'טים מהסוגים הבאים:
    • גאדג'טים מוטבעים (type=html-inline)
    • Mapplets
    • גאדג'טים מסוג כתובת URL (type-url)
    • מודעות גאדג'ט ב-Google AdSense
  • שיקולים בקשר לדומיין
    • כשדורשים את התכונה של Analytics בגאדג'ט, הגאדג'ט יפנה אל <subdomain>.gmodules.com, שם <subdomain> הוא תת-דומיין ייחודי ואקראי. לכן כל התוכן שבגאדג'ט מוצג בתת-הדומיין הזה. לדוגמה: 3nvma227-a.gmodules.com. כמו כן, כל קובצי ה-cookie למעקב של Google Analytics מוגדרים לתת-דומיין ייחודי זה. מסיבה זו, תבניות מעקב אינן נתמכות על ידי תכונת המעקב של Analytics, ועליך לאפשר גישה מיוחדת לתוכן Flash לתכונת המעקב (ראה בהמשך).
  • גאדג'טים שמשתמשים בתוכן Flash
    • גאדג'טים שמשתמשים בתוכן Flash חייבים לאפשר תקשורת בין כתובת ה-URL של ה-Flash לבין כתובת ה-URL של הגאדג'טים, על ידי הגדרת הפרמטר allowScriptAccess כתמיד. 
    _IG_EmbedFlash("example.swf", "wrapper", {allowScriptAccess: "always"});
 

טיפים

איך מומלץ להשתמש בשיטה של כתובת URL וירטואלית

אם אין לך גישה לשיטת המעקב אחר אירועים עבור הגאדג'טים שלך, פעל בהתאם להמלצות הבאות למעקב אחר הגאדג'טים שלך באמצעות שיטת כתובת האתר הווירטואלית:

  • מפלחים את טעינת הגאדג'ט בנפרד.
    • אפשר לקרוא לפונקציה ga.reportPageview() בטעינת גאדג'ט על מנת לספק נתיב שמפלח את הנתונים הסטטיסטיים של טעינה/הצגה של גאדג'ט בנפרד ממדדי האינטראקציה של הגאדג'ט. פעולה זו תשמור את נתוני הדיווח על התוכן של הגאדג'ט ב"ספרייה" נפרדת מהאינטראקציות עם הגאדג'ט, כך שתוכל לראות את כל הצפיות שלך בנפרד ממספר האינטראקציות בגאדג'ט עצמו. לדוגמה, ניתן להשתמש בקטע הקוד הבא בגאדג'ט כדי להציג את כל הנתונים הסטטיסטיים לגבי טעינת הגאדג'ט: 
      ga.reportPageview('/view/gadgetName');
  • פילוח סוגי אינטראקציות שונים זה מזה.
    • קוראים ל-ga.reportPageview() עם נתיב שמפלח אינטראקציות שונות של המשתמשים. כך ניתן לקבל דיווח נפרד על תוכן עבור קישורים של גאדג'טים, לחצנים של גאדג'טים או ווידג'טים אחרים שייתכן שתרצו לעקוב אחריהם כדי לקבל נתוני אינטראקציה. למשל:
    • ga.reportPageview('/link/click');
    • ga.reportPageview('/link/submit');

שימוש בשיטה 'מעקב אחר אירועים'

אם יש לכם גישה לתכונה 'מעקב אחר אירועים' בדוחות של Google Analytics, תוכלו לנצל את מודל הנתונים הגמיש מאוד כדי להפיק את המרב מהמעקב אחר האובייקטים. ריכזנו בשבילכם כמה טיפים:

  • מעקב אחר התצוגה או החשיפה של הגאדג'ט באמצעות ga.reportPageview(), ומעקב אחר האינטראקציה עם הגאדג'ט באמצעות ga.reportEvent().
    • תצוגות של גאדג'טים יוצגו בקטע 'תוכן' של נתוני הדף, ואינטראקציות עם גאדג'טים יוצגו בקטע 'אירועים' בדוחות 'תוכן'.
  • השתמש ב-document.referrer כפרמטר כדי לגלות היכן מוקם הגאדג'ט שלך.
    • בגאדג'ט, document.referrer היא בדרך כלל כתובת ה-URL של הדף במאגר, אז אפשר להעביר אותה כפרמטר של תווית בשיטה ga.reportEvent():
    var containerPage = document.referrer;
ga.reportEvent("Counter Gadget", "Increment", containerPage, 0);

פתרון בעיות

תוכלו להשתמש בכלים של צד שלישי כדי לנתח את מחרוזת הבקשה לקובץ GIF של הגאדג'ט שלכם, כדי לוודא שהנתונים יישלחו לדוחות Google Analytics באופן הרצוי לכם. אחרי שהגאדג'ט מתארח כראוי ופועל בדף הבדיקה, נתח את המחרוזת של בקשת ה-GIF באופן הבא:

  • שיטת הצפייה בדף
    • מחפשים את המשתנה utmp בפרמטרים של בקשת ה-GIF. המידע המשויך למשתנה הזה הוא המידע שיישלח לדוחות של Google Analytics בתור ה"נתיב" של הגאדג'ט.
  • שיטת המעקב אחר אירועים
    • מחפשים את משתנה utme בפרמטרים של הבקשה ל-GIF. המידע הזה צריך להיות בצורה 5(object*action*label)(value).

למידע נוסף על פתרון בעיות בקוד המעקב, עיינו במדריך לפתרון בעיות ב-GATC.