Reports API: דוח פעילות ב-Drive

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

מותר להשתמש בדוח הפעילות ב-Google Drive רק למטרות חוקיות בחשבונות שהוקצתה להם רישיון.

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

אחזור אירועים ב-Google Drive של דומיין

אתם יכולים להשתמש בדוח הפעילות ב-Drive כדי לקבל מידע על המסמכים שלכם ב-Drive. לדוגמה, אפשר לבקש דוח עם רשימה של 25 האירועים האחרונים ב-Drive בחשבון, לאורך תקופה של עד 180 ימים. כדי לקבל את הדוח הזה, צריך לקבל אסימון הרשאה כפי שמתואר במדריך האימות, ואז להשתמש בבקשת ה-HTTP GET הבאה:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?maxResults=25

כאן אפשר לראות דוגמה לתגובה לקריאה הזו ל-API.

בדוגמה הבאה מוצג אחזור של דוח של כל האירועים ב-Drive מ-180 הימים האחרונים, התקופה המקסימלית.

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive

אחזור אירועים ב-Google Drive לפי משתמש

כדי לאחזר דוח של הפעילויות של משתמש מסוים ב-Google Drive, משתמשים בבקשת HTTP GET עם טוקן ההרשאה שמתואר במדריך הרשאה. השדה userKey הוא כתובת האימייל הראשית של המשתמש בדוח, או all לכל המשתמשים.

בדוגמה הבאה מתבצע אחזור של דוח עם פירוט כל השינויים שבוצעו על ידי המשתמש שצוין. דוגמה לתגובת API מופיעה בתגובת JSON לדוגמה.

GET https://admin.googleapis.com/admin/reports/v1/activity/users/kim@example.com
/applications/drive

אחזור אירועים ב-Google Drive של תיקיות אחסון שיתופי

אפשר לאחזר דוח של פעילויות ב-Google Drive עבור אחסון משותף ספציפי באמצעות בקשת HTTP GET עם אסימון ההרשאה שמתואר במדריך ההרשאה. בשדה userKey מציינים את כתובת האימייל של המשתמש שרוצים להריץ את הדוח עבורו, או מציינים all כדי להריץ את הדוח לכל המשתמשים.

הדוגמה הבאה ממחישה איך מאחזרים דוח של כל השינויים בהתקן אחסון נתונים ספציפי. דוגמה לתגובת API מופיעה בתגובת JSON לדוגמה.

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?filters=shared_drive_id==<id of shared drive>

כדי לאחזר אירועים באחסון שיתופי, מסננים באמצעות הסמל doc_type. בדוגמה הבאה מתבצעת אחזור של אירועים שמשפיעים על כל תיקיות האחסון השיתופי:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?filters=doc_type=shared_drive

כדי לאחזר אירועים של שינויים במינויים, מציינים את האירוע shared_drive_membership_change. בדוגמה הבאה מתבצעת אחזור של כל ההוספות של חברים לאחסונים משותפים:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?evetName=shared_drive_membership_change&
filters=membership_change_type==add_to_shared_drive

אחזור אירועים ב-Google Drive לפי סוג האירוע

כדי לאחזר דוח של כל המופעים של סוג אירוע ספציפי, כמו יצירה או עריכה של מסמך, משתמשים בבקשת HTTP GET עם אסימון ההרשאה שמתואר במדריך ההרשאה. השדה userKey הוא כתובת האימייל הראשית של המשתמש בדוח, או all לכל המשתמשים.

בדוגמה הבאה מוצג אחזור של דוח עם כל הפעילויות של יצירת מסמכי התיעוד של החשבון. דוגמה לתגובת API מופיעה בתגובת JSON לדוגמה:

GET https://admin.googleapis.com/admin/reports/v1/activity/users/all
/applications/drive?eventName=create

דוגמה לתגובת JSON

כששולחים בקשת HTTP GET ל-API, התשובה המוצלחת מחזירה את קוד הסטטוס HTTP 200. יחד עם קוד הסטטוס, התשובה מחזירה דוח על ה-Drive. הדוחות האלה זמינים גם במסוף Admin. מידע נוסף זמין במרכז העזרה של Google Workspace לאדמינים. מידע על eventName זמין במאמר שמות של אירועים ב-Drive. למידע נוסף על מחרוזות השאילתה של הבקשה ועל מאפייני התגובה, ראו הפניית API.

{
 "kind": "reports#auditActivities",
 "nextPageToken": "next page's token",
 "items": [
  {
   "kind": "audit#activity",
   "id": {
    "time": "2014-03-17T15:39:18.460Z",
    "uniqQualifier": "report's unique ID",
    "applicationName": "drive",
    "customerId": "ABC123xyz"
   },
   "actor": {
   "callerType": "USER",
   "email": "kim@example.com",
   "profileId": "user's unique Google Workspace profile ID",
   "key": "consumer key of requestor in an OAuth 2LO request"
   },
   "ownerDomain": "domain of the source owner",
   "ipAddress": "user's IP address",
   "events": [
    {
     "type": "access",
     "name": "edit",
     "parameters": [
      {
        "name": "primary_event",
        "boolValue": true
      },
      {
        "name": "owner_is_shared_drive",
        "boolValue": false
      },      {
        "name": "doc_id",
        "value": "1DWuYM3ot_sAyEQqOz0xWJ9bVMSYzOmRNeBqbgtSwuK8"
      },
      {
        "name": "doc_title",
        "value": "Meeting notes"
      },
      {
        "name": "doc_type",
        "value": "document"
      },
      {
        "name": "owner",
        "value": "mary@example.com"
      }
      ]
     }
    ]
   },
  ]
 }