ה-Reports API הוא API מסוג RESTful שמאפשר לגשת למידע על הפעילויות של המשתמשים ב-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, קראו את המדריך קבלת התראות בדחיפה.
השלבים הבאים
רוצים ללמוד על ה-Reports API כדי לראות איך הוא פועל? תוכלו להיעזר במדריך למתחילים, שמפורטת לפי שפת התכנות בסרגל הניווט הימני. אפשר גם להמשיך לקרוא את הקטע הזה כדי לקרוא מידע כללי על הגדרת החשבון.
בקטע הרשאה מוסבר איך להשתמש באסימוני גישה מסוג OAuth 2.0 כדי לקבל נתוני משתמשים מאפליקציות ומשירותים של Google Workspace.
כדי למצוא את הפרטים של סוג משאב או שיטה ספציפיים, ראו הפניית API.
למידע נוסף, תוכלו לקרוא על מעקב אחר בעיות ב-Admin SDK API, בבלוג של Google Workspace Developers ובמרכז העזרה לאדמינים של Google Workspace.