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

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

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

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

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

  • כמה משתמשים פעילים ביום היו לאפליקציית Android שלך בשבוע האחרון.
  • מספר הצפיות בדפים המובילים באתר ב-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"
}

שיטות זמינות

זו רשימה של ה-methods של 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 קבוצה של שיטות שמאפשרות ליצור קובצי Audience Exports, שכוללים תמונת מצב של המשתמשים בקהל.
  • properties.recurringAudienceLists (גרסת טרום-השקה מוקדמת) קבוצת שיטות שמאפשרות לכם לנהל ייצוא חוזר של קהלים. ייצוא חוזר של קהל יוצר רשימות קהלים חדשות בכל יום.
  • ‫runFunnelReport ‫(גרסת טרום-השקה מוקדמת) השיטה הזו מאפשרת לקבל דוח משפך מותאם אישית של נתוני האירועים ב-Google Analytics. ניתוח משפך (Funnel Exploration) הוא תצוגה חזותית של כל הפעולות שמשתמשים עושים כדי להשלים משימה, שאפשר לראות בה בקלות עד כמה הם מצליחים בכל שלב.
  • ‫properties.chat ‫(גרסת טרום-השקה מוקדמת) השיטה הזו מספקת גישה פרוגרמטית לשיחה עם Ask Advisor ב-Google Analytics. אתם יכולים לשאול שאלות בשפה טבעית לגבי נתוני האירועים, לאבחן שינויים בביצועים ולקבל תובנות מובנות בפורמט של טקסט וטבלה.

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

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