ממשק ה-API של דוחות הוא ממשק API של RESTful שבו ניתן להשתמש כדי לגשת למידע על הפעילויות של המשתמשים שלך ב-Google Workspace. Reporting API הוא חלק מ-Admin SDK API.
ה-Reporting API מספק שני סוגים של דוחות:
- דוחות פעילות, שמדווחים על אירועים באפליקציה או בשירות ספציפיים, כמו Google Drive או מסוף Admin.
- דוחות שימוש, שבהם רשומים אירועי סביבת עבודה שנגרמו על ידי משתמשים.
- דוחות השימוש של הלקוח מפרטים אירועים עבור כל המשתמשים בדומיין שלך.
- דוחות שימוש של משתמש מפרטים אירועים המאורגנים לפי משתמש.
בהמשך מופיעה רשימה של מונחים נפוצים שנעשה בהם שימוש ב-Reports API:
- דוחות פעילות
בדוחות הפעילות מפורט מידע על פעילויות באפליקציה או בשירות ספציפיים של Google Workspace. דוחות הפעילות כוללים את התאריך, השעה, המשתמש וסוג הפעילות. הפניית API כוללת רשימה מלאה של דוחות הפעילות והמידע שהם כוללים. הנה כמה דוחות על פעילות לדוגמה, המפורטים לפי אפליקציה או שירות:
- דוחות פעילות של אדמינים מציגים פעילויות שבוצעו על ידי אדמינים באמצעות מסוף Admin. לדוגמה, אפשר לקבל רשימה של כל הפעמים שהאדמינים שינו שם של משתמש באמצעות מסוף Admin.
- בדוחות הפעילות של Google Drive מפורט האופן שבו המשתמשים בדומיין שלכם עורכים את המסמכים שלהם ב-Drive ובודקים אותם. לדוגמה, אפשר לקבל רשימה של פעילות משתמש מסוים ב-Drive.
- דוחות פעילות התחברות מספקים מידע על המועד שבו המשתמשים נכנסים לחשבון ויוצאים ממנו. לדוגמה, תוכלו לקבל דוח עם כל הכניסות לדומיין שלכם בתקופת זמן מסוימת.
- דוחות פעילות בנייד מציגים פעילויות באמצעות מכשירים ניידים המנוהלים על ידי ניהול מכשירים ניידים ב-Google. למשל, אפשר לקבל התראה כשמשתמשים רושמים מכשיר חדש.
- דוחות פעילות של אסימוני OAuth מפרטים אירועים שבהם המשתמשים נתנו או ביטלו אסימוני הרשאה ששימשו אתרים ואפליקציות של צד שלישי. תוכלו להשתמש ב-Reporting API כדי לקבל רשימה של כל הגישה של צד שלישי לנתוני Google Workspace של המשתמש.
- דוחות שימוש
דוחות השימוש מספקים מידע על אירועים ב-Google Workspace בדומיין שלכם. אפשר להשתמש ב-API כדי לבקש מידע ספציפי על משתמשים.
- דוחות שימוש של לקוחות מפרטים פעילויות מפורטות של אפליקציות ושירותים בחשבון שלך. פרטי השימוש מאורגנים לפי סוג האפליקציה, ומכילים מידע ספציפי לאותה אפליקציה.
- דוחות שימוש של משתמשים מציגים פעילויות של משתמשי החשבון. אפשר להתאים אישית את הדוחות ולסנן אותם לפי מידע ספציפי על השימוש. מידע השימוש הזה מאורגן לפי סוג האפליקציה ומכיל מידע ספציפי לאותה אפליקציה.
- דוחות שימוש בישויות מפרטים פעילויות הקשורות לישויות שמשתמשי החשבון שלכם משתמשים בהן ב-Currents.
- התראות
- ב-Reporting API אפשר לקבל התראות על אירועים, כמו שינויים במשאבים. כאשר אתם צופים במשאב והמשאב משתנה, ה-Reporting API שולח לכם התראה. למידע נוסף על ההגדרה והקבלה של התראות מ-Reporting API, אפשר לעיין במדריך קבלת התראות.
השלבים הבאים
כדי ללמוד על Reporting API ולראות איך הוא עובד, אפשר להשתמש ב-Quickstart, שמופיע לפי שפת תכנות בסרגל הניווט הימני. תוכלו גם להמשיך לעיין בקטע הזה כדי לקרוא מידע כללי על הגדרת החשבון.
כדי להשתמש ב-Reports API, צריך לבצע את השלבים המוקדמים כדי להגדיר את החשבון ולהפוך לאדמין. תוכלו גם ליצור פרויקט ולרשום אותו באמצעות Google API Console, ולהפעיל את שירות Reporting API.
בקטע הרשאה מוסבר איך להשתמש באסימוני גישה מסוג OAuth 2.0 כדי להשיג נתוני משתמשים מאפליקציות ומשירותים של Google Workspace.
בחומר העזר בנושא API תוכלו לקרוא את הפרטים של סוג השיטה הספציפי או השיטה.
למידע נוסף, תוכלו להיעזר במעקב אחר בעיות ב-Admin SDK API ובבלוג Google Workspace Developers ובמרכז העזרה לאדמינים ב-Google Workspace.