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