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 ימים. כדי לקבל את הדוח הזה, משיגים אסימון הרשאה כפי שמתואר במדריך להרשאות, ולאחר מכן משתמשים בבקשת GET הבאה של HTTP:

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 לכל המשתמשים.

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

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"
      }
      ]
     }
    ]
   },
  ]
 }