Reports API: گزارش فعالیت Drive

گزارش فعالیت درایو، اطلاعاتی در مورد فعالیت‌های کاربران شما هنگام مدیریت، تغییر و اشتراک‌گذاری فایل‌ها در گوگل درایو در فضای کاری گوگل (Google Workspace) ارائه می‌دهد. به عنوان مثال، می‌توانید از گزارش فعالیت درایو برای دریافت لیستی از تمام اسناد جدید درایو ایجاد شده توسط یک کاربر خاص در یک بازه زمانی مشخص استفاده کنید. می‌توانید از این اطلاعات برای کسب بینش در مورد مدیریت بهتر محتوا و نشت داده‌های احتمالی استفاده کنید. برای دریافت گزارش، از درخواست نقطه پایانی گزارش پایه با پارامترهای خاص گزارش مانند آدرس ایمیل کاربر یا نوع خاصی از تغییر گوگل درایو استفاده می‌کنید. گزارش‌ها می‌توانند شامل داده‌هایی تا ۱۸۰ روز گذشته باشند.

گزارش فعالیت گوگل درایو فقط برای اهداف قانونی و در حساب‌هایی که مجوز دارند، قابل استفاده است.

برای اطلاعات مربوط به رشته‌های پرس‌وجوی درخواست و ویژگی‌های پاسخ، به مرجع API مراجعه کنید. برای اطلاعات مربوط به رویدادهای خاص مربوط به Google Drive، به نام‌های رویداد Drive مراجعه کنید.

بازیابی رویدادهای گوگل درایو برای یک دامنه

شما می‌توانید از گزارش فعالیت درایو برای فهرست کردن اطلاعات مربوط به اسناد درایو خود استفاده کنید. به عنوان مثال، می‌توانید گزارشی را درخواست کنید که شامل ۲۵ رویداد اخیر درایو حساب شما باشد و تا ۱۸۰ روز را پوشش دهد. برای دریافت این گزارش، یک توکن مجوز را همانطور که در راهنمای مجوز توضیح داده شده است، دریافت کنید، سپس از درخواست HTTP GET زیر استفاده کنید:

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

می‌توانید نمونه‌ای از پاسخ به این فراخوانی API را مشاهده کنید.

مثال زیر گزارشی از تمام رویدادهای Drive را برای ۱۸۰ روز گذشته، حداکثر دوره، بازیابی می‌کند.

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

بازیابی رویدادهای گوگل درایو بر اساس کاربر

برای بازیابی گزارش فعالیت‌های گوگل درایو یک کاربر خاص، از یک درخواست HTTP GET با توکن مجوز شرح داده شده در راهنمای مجوز استفاده کنید. فیلد userKey آدرس ایمیل اصلی کاربر در گزارش یا all برای همه کاربران است.

مثال زیر گزارشی را بازیابی می‌کند که تمام تغییرات ایجاد شده توسط کاربر مشخص شده را فهرست می‌کند. برای نمونه‌ای از پاسخ API، به نمونه پاسخ JSON مراجعه کنید.

GET https://admin.googleapis.com/admin/reports/v1/activity/users/kim@example.com
/applications/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

بازیابی رویدادهای گوگل درایو بر اساس نوع رویداد

برای بازیابی گزارش تمام نمونه‌های یک نوع رویداد خاص، مانند ایجاد یا ویرایش یک سند، از یک درخواست 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 نیز برمی‌گرداند. این گزارش‌ها در کنسول مدیریت نیز موجود هستند. برای اطلاعات بیشتر، به مرکز راهنمای Google Workspace Admin مراجعه کنید. برای اطلاعات 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"
      }
      ]
     }
    ]
   },
  ]
 }