API báo cáo: Báo cáo hoạt động trên Drive

Báo cáo hoạt động trên Drive cung cấp thông tin về các hoạt động của người dùng khi họ quản lý, sửa đổi và chia sẻ tệp trên Google Drive trong Google Workspace. Ví dụ: bạn có thể sử dụng báo cáo hoạt động trên Drive để xem danh sách tất cả các tài liệu mới trên Drive do một người dùng cụ thể tạo trong một phạm vi ngày được chỉ định. Bạn có thể sử dụng thông tin này để có được thông tin chi tiết về cách quản lý nội dung hiệu quả hơn và các nguy cơ rò rỉ dữ liệu có thể xảy ra. Để có được báo cáo, bạn hãy sử dụng yêu cầu điểm cuối của báo cáo cơ bản kèm theo các tham số dành riêng cho báo cáo, chẳng hạn như địa chỉ email của người dùng hoặc một loại thay đổi cụ thể trong Google Drive. Báo cáo có thể chứa dữ liệu trong tối đa 180 ngày qua.

Bạn chỉ có thể sử dụng báo cáo hoạt động trên Google Drive cho các mục đích hợp pháp trong những tài khoản được cấp giấy phép.

Để biết thông tin về chuỗi truy vấn của yêu cầu và các thuộc tính phản hồi, hãy xem Tài liệu tham khảo API. Để biết thông tin về các sự kiện cụ thể liên quan đến Google Drive, hãy xem bài viết Tên sự kiện trên Drive.

Truy xuất các sự kiện trên Google Drive cho một miền

Bạn có thể sử dụng báo cáo hoạt động trên Drive để liệt kê thông tin về các tài liệu trên Drive của mình. Ví dụ: bạn có thể yêu cầu một báo cáo liệt kê 25 sự kiện Drive gần đây nhất trong tài khoản của mình, trong tối đa 180 ngày. Để tải báo cáo này, hãy lấy mã thông báo uỷ quyền như mô tả trong hướng dẫn uỷ quyền, sau đó sử dụng yêu cầu HTTP GET sau:

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

Bạn có thể xem ví dụ về phản hồi cho lệnh gọi API này.

Ví dụ sau đây truy xuất báo cáo về tất cả sự kiện Drive trong 180 ngày qua, khoảng thời gian tối đa.

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

Truy xuất các sự kiện trên Google Drive theo người dùng

Để truy xuất báo cáo về hoạt động trên Google Drive của một người dùng cụ thể, hãy sử dụng yêu cầu HTTP GET có mã thông báo uỷ quyền được mô tả trong hướng dẫn hướng dẫn uỷ quyền. Trường userKey là địa chỉ email chính của người dùng trong báo cáo hoặc all đối với tất cả người dùng.

Ví dụ sau đây truy xuất một báo cáo liệt kê tất cả các thay đổi do người dùng được chỉ định thực hiện. Để biết ví dụ về phản hồi API, hãy xem phản hồi JSON mẫu.

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

Truy xuất sự kiện trên Google Drive cho bộ nhớ dùng chung

Bạn có thể truy xuất báo cáo về các hoạt động trên Google Drive cho một bộ nhớ dùng chung cụ thể bằng cách sử dụng yêu cầu HTTP GET với mã thông báo uỷ quyền được mô tả trong hướng dẫn uỷ quyền. Chỉ định địa chỉ email của người dùng bạn muốn chạy báo cáo trong trường userKey hoặc chỉ định all để chạy báo cáo trên tất cả người dùng.

Ví dụ sau đây truy xuất báo cáo về tất cả các thay đổi đối với một bộ nhớ dùng chung cụ thể. Để biết ví dụ về phản hồi API, hãy xem phản hồi JSON mẫu.

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

Để truy xuất sự kiện của một bộ nhớ dùng chung, hãy lọc bằng doc_type. Ví dụ sau đây truy xuất các sự kiện ảnh hưởng đến tất cả bộ nhớ dùng chung:

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

Để truy xuất sự kiện cho các thay đổi về thành viên, hãy chỉ định sự kiện shared_drive_membership_change. Ví dụ sau đây truy xuất tất cả thành phần bổ sung cho bộ nhớ dùng chung:

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

Truy xuất sự kiện trên Google Drive theo loại sự kiện

Để truy xuất báo cáo về tất cả các phiên bản của một loại sự kiện cụ thể, chẳng hạn như tạo hoặc chỉnh sửa tài liệu, hãy sử dụng yêu cầu HTTP GET có mã thông báo uỷ quyền được mô tả trong hướng dẫn uỷ quyền. Trường userKey là địa chỉ email chính của người dùng trong báo cáo hoặc all đối với tất cả người dùng.

Ví dụ sau đây truy xuất báo cáo về tất cả các hoạt động tạo tài liệu cho tài khoản. Để xem ví dụ về phản hồi API, hãy xem phản hồi JSON mẫu:

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

Ví dụ về phản hồi JSON

Khi bạn gửi yêu cầu HTTP GET đến API, phản hồi thành công sẽ trả về mã trạng thái HTTP 200. Cùng với mã trạng thái, phản hồi sẽ trả về một báo cáo cho Drive. Những báo cáo này cũng có trong Bảng điều khiển dành cho quản trị viên. Để biết thêm thông tin, hãy truy cập vào Trung tâm trợ giúp dành cho Quản trị viên Google Workspace. Để biết thông tin về eventName, hãy xem tài liệu tham khảo về tên sự kiện Drive. Để biết thêm thông tin về chuỗi truy vấn của yêu cầu và các thuộc tính phản hồi, hãy xem Tài liệu tham khảo 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"
      }
      ]
     }
    ]
   },
  ]
 }