סקירה כללית של Google Analytics Data API

אתם יכולים להשתמש ב-Data API כדי לגשת באופן פרוגרמטי לנתוני הדוחות של Google Analytics.

מידע נוסף על נכסי Google Analytics

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

הנה כמה דוגמאות לנתונים שאפשר לדווח עליהם באמצעות Google Analytics Data API v1:

  • כמה משתמשים פעילים ביום היו לאפליקציה ל-Android בשבוע האחרון.
  • כמה צפיות היו ב-10 הדפים המובילים באתר ב-28 הימים האחרונים.
  • כמה משתמשים פעילים היו באפליקציה ל-iOS בכל מדינה ב-30 הדקות האחרונות.

אתם יכולים גם להשתמש ב-Google Analytics Data API v1 כדי:

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

עקביות בנתונים וזיהוי של מי שמדווח

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

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

שנתחיל?

כדי להתחיל לעבוד עם ספריית לקוח ב-Java, ב-Python, ב-Node.js, ב-PHP, ב-C#‎, ב-Go או ב-Ruby, עיינו במדריך למתחילים בנושא ספריות לקוח. כדי ללמוד איך ליצור שאילתות, לסנן מאפיינים ולקרוא תגובות, אפשר לעיין במאמר יצירת דוח או לבדוק שאילתות באופן אינטראקטיבי ב-Query Explorer.

דוגמה לבקשה ולתשובה של runReport

כדי לשלוח שאילתה על נתוני אירועים באמצעות REST, שולחים בקשת POST לנקודת הקצה runReport עם גוף JSON מסוג RunReportRequest שמציין את dateRanges, dimensions ו-metrics:

POST https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport
{
  "dateRanges": [
    { "startDate": "7daysAgo", "endDate": "yesterday" }
  ],
  "dimensions": [
    { "name": "country" }
  ],
  "metrics": [
    { "name": "activeUsers" }
  ]
}

או מריצים את הפקודה המקבילה של curl באמצעות Application Default Credentials:

curl -X POST \
  "https://analyticsdata.googleapis.com/v1beta/properties/GA_PROPERTY_ID:runReport" \
  -H "Authorization: Bearer $(gcloud auth application-default print-access-token)" \
  -H "x-goog-user-project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "dateRanges": [
      { "startDate": "7daysAgo", "endDate": "yesterday" }
    ],
    "dimensions": [
      { "name": "country" }
    ],
    "metrics": [
      { "name": "activeUsers" }
    ]
  }'

ה-API מחזיר RunReportResponse שמכיל כותרות של עמודות ושורות של נתונים:

{
  "dimensionHeaders": [
    { "name": "country" }
  ],
  "metricHeaders": [
    { "name": "activeUsers", "type": "TYPE_INTEGER" }
  ],
  "rows": [
    {
      "dimensionValues": [{ "value": "United States" }],
      "metricValues": [{ "value": "4820" }]
    },
    {
      "dimensionValues": [{ "value": "Japan" }],
      "metricValues": [{ "value": "2541" }]
    }
  ],
  "rowCount": 2,
  "kind": "analyticsData#runReport"
}

השיטות הזמינות

זו רשימה של השיטות של Data API. למידע נוסף, קראו את מאמרי העזרה.

  • ‫runReport השיטה הזו מחזירה דוח בהתאמה אישית של נתוני האירועים ב-Google Analytics, והיא השיטה המועדפת לשאילתות פשוטות של דוחות.
  • ‫batchRunReports זוהי גרסת אצווה של השיטה runReport, שמאפשרת ליצור כמה דוחות באמצעות קריאה אחת ל-API.
  • runPivotReport השיטה הזו מאפשרת לקבל דוח ציר מותאם אישית של נתוני האירועים ב-Google Analytics. דוחות צירים הם פורמטים מתקדמים ובעלי יכולת ביטוי רבה יותר מאשר דוחות רגילים. כל ציר מתאר את העמודות והשורות של המאפיינים שמוצגים בתגובה לדוח.
  • batchRunPivotReports זוהי גרסת אצווה של השיטה runPivotReport, שמאפשרת ליצור כמה דוחות באמצעות קריאה אחת ל-API.
  • ‫getMetadata השיטה הזו מחזירה מטא-נתונים של מאפיינים ומדדים שזמינים בשיטות הדיווח. משמש לניתוח המאפיינים והמדדים. התגובה של השיטה הזו כוללת גם את המאפיינים והמדדים המותאמים אישית שזמינים לנכס שצוין ב-Google Analytics.
  • checkCompatibility השיטה הזו מציגה רשימה של מאפיינים ומדדים שאפשר להוסיף לבקשת דוח ולשמור על תאימות.
  • runRealtimeReport השיטה הזו מאפשרת לקבל דוח מותאם אישית של נתוני אירועים בזמן אמת בנכס. אירועים מופיעים בדוחות "פעילות בזמן אמת" כמה שניות אחרי שהם נשלחים אל Google Analytics. בדוחות "פעילות בזמן אמת" מוצגים אירועים ונתוני שימוש בפרקי זמן שנעים בין הרגע הנוכחי לבין 30 דקות לפני כן (עד 60 דקות בנכסי Google Analytics 360).
  • properties.audienceExports קבוצה של שיטות שמאפשרות ליצור ייצוא של קהלים, שכולל תמונת מצב של המשתמשים בקהל.
  • properties.recurringAudienceLists (גרסת טרום-השקה מוקדמת) קבוצת שיטות שמאפשרות לנהל ייצוא חוזר של קהלים. ייצוא חוזר של קהל יוצר רשימות קהלים חדשות בכל יום.
  • runFunnelReport (גרסת טרום-השקה מוקדמת) השיטה הזאת מאפשרת לקבל דוח משפך מותאם אישית של נתוני האירוע ב-Google Analytics. ניתוח משפך (Funnel Exploration) הוא תצוגה חזותית של כל הפעולות שמשתמשים עושים כדי להשלים משימה, שאפשר לראות בה בקלות עד כמה הם מצליחים בכל שלב.
  • properties.chat (גרסת טרום-השקה מוקדמת) השיטה הזו מספקת גישה פרוגרמטית לשיחות עם Ask Advisor ב-Google Analytics. אתם יכולים לשאול שאלות בשפה טבעית על נתוני האירועים, לאבחן שינויים בביצועים ולקבל תובנות מובנות בטבלאות ובתיאורים מילוליים.

מאפיינים ומדדים נתמכים

לרשימה של כל המאפיינים והמדדים שנתמכים ב-Data API, עיינו במסמכי התיעוד של סכימת ה-API.