מהו ה-Core Reporting API – סקירה כללית

מסמך זה מספק סקירה כללית ברמה 3.0 על ממשק ה-API הראשי לדיווח של Google Analytics. מידע מפורט על ה-API זמין במדריך העזר.

מבוא

Google Analytics Core Reporting API נותן לך גישה לרוב נתוני הדוחות ב-Google Analytics. בעזרת ה-Core Reporting API אפשר:

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

בחירת גרסה

לאחרונה השקנו גרסה חדשה של Core Reporting API.

  • יוצרים אפליקציה חדשה? – מומלץ להשתמש בגרסה 3.0 העדכנית ביותר.
  • משתמשים בגרסה 2.3 מדור קודם? – ניתן לקרוא את המדריך להעברת נתונים (מיגרציה) כדי לקבל פרטים על אופן העדכון של האפליקציה לשימוש בגרסה החדשה.

תחילת העבודה

רוצה להתחיל בעבודה כבר עכשיו? קראו את מדריך השימוש ב-API של Analytics.

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

סקירה כללית של קונספט

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

ה-Core Reporting API כולל 3 מושגים בסיסיים:

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

דוחות, משתמשים ותצוגות מפורטות (פרופילים)

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

יש כמה דרכים לאתר את מזהה התצוגה (פרופיל).

  • אתם יכולים להשתמש ב-Management API כדי לעבור בין היררכיית ההגדרות של הניהול כדי לקבל מזהה של תצוגה מפורטת (פרופיל).
  • בכתובת ה-URL של כל דוח ב-Google Analytics.
  • ב-Google Analytics, לוחצים על ניהול בסרגל התפריטים. בוחרים את החשבון ואת הנכס שאליהם שייכת התצוגה המפורטת. בעמודה תצוגה מפורטת, לוחצים על הגדרות תצוגה מפורטת כדי לקבל את מזהה התצוגה המפורטת.

שאילתה לגבי מאפיינים ומדדים

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

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

עבודה עם דוחות

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

מידע נוסף על התגובה ל-API זמין במדריך העזר המרכזי לדיווח על API.

חזרה למעלה

מדיניות בנושא מכסות והוצאה משימוש

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

לפרטים על אופן הטיפול בשינויים בעמודות Core Reporting API (כלומר מאפיינים ומדדים), ניתן לקרוא את המדיניות בנושא הוצאה משימוש של נתונים. ב מדריך למפתחים בנושא Metadata API מוסבר איך משתמשים ב- Metadata API כדי לבדוק אם יש עמודות שהוצאו משימוש.

השלבים הבאים

עכשיו כשאתם מבינים איך ה-API פועל, יש לנו כמה משאבים שיעזרו לכם להתחיל:

חזרה למעלה