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 עבור תיקייה ספציפית ב-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?eventName=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. מידע נוסף זמין במאמר בנושא שמות של אירועים ב-Drive.eventName מידע נוסף על מחרוזות השאילתות של הבקשה ומאפייני התגובה זמין בהפניית ה-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 requester 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"
      }
      ]
     }
    ]
   },
  ]
 }