סקירה כללית על Reports API

Reports API הוא ממשק API מסוג REST שבעזרתו אפשר לגשת למידע על הפעילויות של המשתמשים ב-Google Workspace. Reports API הוא חלק מ-Admin SDK API.

ב-Reports API יש שני סוגים של דוחות:

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

ריכזנו כאן רשימה של מונחים נפוצים שמופיעים ב-Reports API:

דוחות פעילות

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

  • דוחות פעילות של אדמינים מציגים פעילויות שבוצעו על ידי אדמינים באמצעות מסוף Admin. לדוגמה, תוכלו לקבל רשימה של כל הפעמים שבהן אדמינים שינו את שם המשתמש באמצעות מסוף Admin.
  • דוחות הפעילות ב-Google Drive מפרטים איך המשתמשים בדומיין עורכים ומציגים את המסמכים שלהם ב-Drive. לדוגמה, אפשר לקבל רשימה של הפעילות של משתמש מסוים ב-Drive.
  • דוחות על פעילות ההתחברות מספקים מידע על הזמנים שבהם המשתמשים בחשבון נכנסים לחשבונות שלהם ויוצאים מהם. לדוגמה, אפשר לקבל דוח של כל הכניסות לדומיין שלכם בפרק זמן מסוים.
  • בדוחות הפעילות בנייד מוצגות פעילויות שבוצעו במכשירים ניידים שמנוהלים על ידי Google Mobile Management. לדוגמה, אתם יכולים לקבל התראה כשמשתמשים רושמים מכשיר חדש.
  • בדוחות הפעילות של אסימוני OAuth מפורטים אירועים שבהם המשתמשים העניקו או ביטלו אסימוני הרשאה שמשמשים אתרים ואפליקציות של צד שלישי. אפשר להשתמש ב-Reports API כדי לקבל רשימה של כל הצדדים השלישיים שיש להם גישה לנתונים של משתמש ב-Google Workspace.
דוחות שימוש

דוחות השימוש מספקים מידע על אירועים ב-Google Workspace בדומיין שלכם. אפשר להשתמש ב-API כדי לבקש מידע ספציפי על משתמשים.

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

השלבים הבאים