מהו ממשק ה-API הראשי לדיווח – סקירה כללית

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

מבוא

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

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

בחירת גרסה

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

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

תחילת העבודה

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

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

סקירת קונספט

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

יש 3 עקרונות יסוד שעליהם מבוסס ה-API הראשי לדיווח:

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

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

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

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

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

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

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

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

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

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

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

חזרה למעלה

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

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

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

השלבים הבאים

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

חזרה למעלה