Method: activities.list

Truy xuất danh sách hoạt động cho tài khoản và ứng dụng của một khách hàng cụ thể, chẳng hạn như ứng dụng Bảng điều khiển dành cho quản trị viên hoặc ứng dụng Google Drive. Để biết thêm thông tin, hãy xem hướng dẫn dành cho quản trị viên và báo cáo hoạt động trên Google Drive. Để biết thêm thông tin về các thông số của báo cáo hoạt động, hãy xem hướng dẫn tham khảo về thông số hoạt động.

Yêu cầu HTTP

GET https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
userKey

string

Biểu thị mã hồ sơ hoặc email của người dùng mà dữ liệu sẽ được lọc. Có thể là all đối với tất cả thông tin hoặc userKey đối với mã hồ sơ Google Workspace duy nhất của người dùng hoặc địa chỉ email chính của họ. Không được là người dùng đã bị xoá. Đối với người dùng đã bị xoá, hãy gọi users.list trong API Thư mục với showDeleted=true, sau đó sử dụng ID được trả về làm userKey.
applicationName

enum (ApplicationName)

Tên ứng dụng mà các sự kiện cần được truy xuất.

Tham số truy vấn

Thông số
actorIpAddress

string

Địa chỉ Giao thức Internet (IP) của máy chủ lưu trữ nơi sự kiện được thực hiện. Đây là một cách khác để lọc phần tóm tắt của báo cáo bằng địa chỉ IP của người dùng có hoạt động đang được báo cáo. Địa chỉ IP này có thể phản ánh hoặc không phản ánh vị trí thực tế của người dùng. Ví dụ: địa chỉ IP có thể là địa chỉ của máy chủ proxy của người dùng hoặc địa chỉ mạng riêng ảo (VPN). Tham số này hỗ trợ cả phiên bản địa chỉ IPv4 và IPv6.
customerId

string

Mã nhận dạng duy nhất của khách hàng để truy xuất dữ liệu.
endTime

string

Đặt thời điểm kết thúc của phạm vi thời gian hiển thị trong báo cáo. Ngày ở định dạng RFC 3339, ví dụ: 2010-10-28T10:26:35.000Z. Giá trị mặc định là thời gian gần đúng của yêu cầu API. Báo cáo API có ba khái niệm thời gian cơ bản:

  • Ngày yêu cầu báo cáo của API: Thời điểm API tạo và truy xuất báo cáo.
  • Thời gian bắt đầu của báo cáo: Thời điểm bắt đầu của khoảng thời gian hiển thị trong báo cáo. startTime phải trước endTime (nếu được chỉ định) và thời gian hiện tại khi yêu cầu được thực hiện, nếu không API sẽ trả về lỗi.
  • Thời gian kết thúc của báo cáo: Thời điểm kết thúc của khoảng thời gian hiển thị trong báo cáo. Ví dụ: khoảng thời gian của các sự kiện được tóm tắt trong một báo cáo có thể bắt đầu từ tháng 4 và kết thúc vào tháng 5. Bạn có thể yêu cầu báo cáo này vào tháng 8.
Nếu bạn không chỉ định endTime, báo cáo sẽ trả về tất cả hoạt động từ startTime cho đến thời điểm hiện tại hoặc 180 ngày gần đây nhất nếu startTime cách thời điểm hiện tại hơn 180 ngày.
eventName

string

Tên của sự kiện mà API đang truy vấn. Mỗi eventName liên quan đến một dịch vụ hoặc tính năng cụ thể của Google Workspace mà API sắp xếp thành các loại sự kiện. Ví dụ: sự kiện trên Lịch Google trong báo cáo của ứng dụng Bảng điều khiển dành cho quản trị viên. Cấu trúc type Cài đặt lịch có tất cả các hoạt động eventName Lịch do API báo cáo. Khi quản trị viên thay đổi một chế độ cài đặt Lịch, API sẽ báo cáo hoạt động này trong phần Cài đặt lịch type và tham số eventName. Để biết thêm thông tin về chuỗi truy vấn và tham số eventName, hãy xem danh sách tên sự kiện cho nhiều ứng dụng ở trên trong applicationName.
filters

string

Chuỗi truy vấn filters là một danh sách được phân tách bằng dấu phẩy, bao gồm các tham số sự kiện do toán tử quy chiếu thao tác. Thông số sự kiện có dạng {parameter1 name}{relational operator}{parameter1 value},{parameter2 name}{relational operator}{parameter2 value},...

Các thông số sự kiện này được liên kết với một eventName cụ thể. Hệ thống sẽ trả về một báo cáo trống nếu tham số của yêu cầu không thuộc eventName. Để biết thêm thông tin về các trường eventName có sẵn cho mỗi ứng dụng và các tham số liên quan, hãy chuyển đến bảng ApplicationName, sau đó nhấp vào trang Sự kiện hoạt động trong Phụ lục của ứng dụng mà bạn muốn.

Trong các ví dụ sau về hoạt động trên Drive, danh sách được trả về bao gồm tất cả sự kiện edit, trong đó giá trị thông số doc_id khớp với các điều kiện do toán tử quy chiếu xác định. Trong ví dụ đầu tiên, yêu cầu trả về tất cả tài liệu đã chỉnh sửa có giá trị doc_id bằng 12345. Trong ví dụ thứ hai, báo cáo sẽ trả về mọi tài liệu đã chỉnh sửa có giá trị doc_id không bằng 98765. Toán tử <> được mã hoá URL trong chuỗi truy vấn của yêu cầu (%3C%3E):

GET...&eventName=edit&filters=doc_id==12345
GET...&eventName=edit&filters=doc_id%3C%3E98765

Truy vấn filters hỗ trợ các toán tử quy chiếu sau:

  • == – "bằng".
  • <> – "không bằng". Phải được mã hoá URL (%3C%3E).
  • < – "nhỏ hơn". Phải được mã hoá URL (%3C).
  • <= – "nhỏ hơn hoặc bằng". Phải được mã hoá URL (%3C=).
  • >—'lớn hơn'. Phải là URL được mã hoá (%3E).
  • >= – "lớn hơn hoặc bằng". Phải được mã hoá URL (%3E=).

Lưu ý: API không chấp nhận nhiều giá trị của cùng một tham số. Nếu một tham số được cung cấp nhiều lần trong yêu cầu API, thì API chỉ chấp nhận giá trị cuối cùng của tham số đó. Ngoài ra, nếu bạn cung cấp một tham số không hợp lệ trong yêu cầu API, thì API sẽ bỏ qua tham số đó và trả về phản hồi tương ứng với các tham số hợp lệ còn lại. Nếu không có tham số nào được yêu cầu, tất cả tham số sẽ được trả về.
maxResults

integer

Xác định số lượng bản ghi hoạt động hiển thị trên mỗi trang phản hồi. Ví dụ: nếu yêu cầu đặt maxResults=1 và báo cáo có hai hoạt động, thì báo cáo sẽ có hai trang. Thuộc tính nextPageToken của phản hồi có mã thông báo đến trang thứ hai. Chuỗi truy vấn maxResults là không bắt buộc trong yêu cầu. Giá trị mặc định là 1000.
orgUnitID

string

Mã của đơn vị tổ chức mà bạn muốn báo cáo. Bản ghi hoạt động sẽ chỉ hiển thị cho người dùng thuộc đơn vị tổ chức được chỉ định.

pageToken

string

Mã thông báo để chỉ định trang tiếp theo. Một báo cáo có nhiều trang sẽ có một thuộc tính nextPageToken trong phản hồi. Trong yêu cầu tiếp theo để nhận trang tiếp theo của báo cáo, hãy nhập giá trị nextPageToken vào chuỗi truy vấn pageToken.
startTime

string

Đặt thời điểm bắt đầu của phạm vi thời gian hiển thị trong báo cáo. Ngày ở định dạng RFC 3339, ví dụ: 2010-10-28T10:26:35.000Z. Báo cáo trả về tất cả hoạt động từ startTime cho đến endTime. startTime phải trước endTime (nếu được chỉ định) và thời gian hiện tại khi yêu cầu được thực hiện, nếu không API sẽ trả về lỗi.
groupIdFilter

string

Mã nhận dạng nhóm được phân tách bằng dấu phẩy (đã làm rối mã) mà hoạt động của người dùng được lọc theo đó, tức là phản hồi sẽ chỉ chứa hoạt động của những người dùng thuộc ít nhất một trong các mã nhận dạng nhóm được đề cập ở đây. Định dạng: "id:abc123,id:xyz456"

Nội dung yêu cầu

Nội dung yêu cầu phải trống.

Nội dung phản hồi

Mẫu JSON cho một tập hợp các hoạt động.

Nếu thành công, phần nội dung phản hồi sẽ chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng JSON 
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (Activity)
    }
  ],
  "nextPageToken": string
}
Trường
kind

string

Loại tài nguyên API. Đối với báo cáo hoạt động, giá trị là reports#activities.
etag

string

ETag của tài nguyên.
items[]

object (Activity)

Mỗi bản ghi hoạt động trong phản hồi.
nextPageToken

string

Mã thông báo để truy xuất trang tiếp theo của báo cáo. Giá trị nextPageToken được dùng trong chuỗi truy vấn pageToken của yêu cầu.

Phạm vi uỷ quyền

Yêu cầu phạm vi OAuth sau:

  • https://www.googleapis.com/auth/admin.reports.audit.readonly

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

ApplicationName

Enum
access_transparency

Báo cáo hoạt động Access Transparency của Google Workspace trả về thông tin về nhiều loại sự kiện hoạt động Access Transparency.
admin

Báo cáo hoạt động của ứng dụng Bảng điều khiển dành cho quản trị viên trả về thông tin tài khoản về nhiều loại sự kiện hoạt động của quản trị viên.
calendar

Báo cáo hoạt động của ứng dụng Lịch Google trả về thông tin về nhiều sự kiện hoạt động trên Lịch.
chat Báo cáo Hoạt động trên Chat trả về thông tin về nhiều sự kiện hoạt động trên Chat.
drive

Báo cáo hoạt động của ứng dụng Google Drive trả về thông tin về nhiều sự kiện hoạt động trên Google Drive. Báo cáo hoạt động trên Drive chỉ dành cho khách hàng Google Workspace Business và Enterprise.
gcp Báo cáo hoạt động của ứng dụng Google Cloud Platform trả về thông tin về nhiều sự kiện hoạt động trên GCP.
gplus Báo cáo hoạt động của ứng dụng Google+ trả về thông tin về nhiều sự kiện hoạt động trên Google+.
groups

Báo cáo hoạt động của ứng dụng Google Groups trả về thông tin về nhiều sự kiện hoạt động trong Groups.
groups_enterprise

Báo cáo hoạt động của Groups Enterprise trả về thông tin về nhiều sự kiện hoạt động của nhóm Enterprise.
jamboard Báo cáo hoạt động trên Jamboard trả về thông tin về nhiều sự kiện hoạt động trên Jamboard.
login

Báo cáo hoạt động của ứng dụng Đăng nhập trả về thông tin tài khoản về nhiều loại sự kiện Hoạt động đăng nhập.
meet Báo cáo Hoạt động kiểm tra Meet trả về thông tin về các loại sự kiện hoạt động kiểm tra Meet.
mobile Báo cáo Hoạt động kiểm tra thiết bị trả về thông tin về các loại sự kiện Hoạt động kiểm tra thiết bị.
rules

Báo cáo Hoạt động theo quy tắc trả về thông tin về các loại sự kiện Hoạt động theo quy tắc.
saml

Báo cáo hoạt động SAML trả về thông tin về các loại sự kiện hoạt động SAML.
token

Báo cáo hoạt động của ứng dụng Mã thông báo trả về thông tin tài khoản về nhiều loại sự kiện Hoạt động mã thông báo.
user_accounts

Báo cáo hoạt động của ứng dụng Tài khoản người dùng trả về thông tin tài khoản về nhiều loại sự kiện hoạt động trong Tài khoản người dùng.
context_aware_access

Báo cáo Hoạt động truy cập theo ngữ cảnh trả về thông tin về các sự kiện từ chối truy cập của người dùng do Quy tắc truy cập theo ngữ cảnh.
chrome

Báo cáo hoạt động trên Chrome trả về thông tin về các sự kiện của trình duyệt Chrome và ChromeOS.
data_studio Báo cáo hoạt động của Data Studio trả về thông tin về nhiều loại sự kiện hoạt động của Data Studio.
keep Báo cáo hoạt động của ứng dụng Keep trả về thông tin về các sự kiện hoạt động trên Google Keep. Báo cáo hoạt động trên Keep chỉ dành cho khách hàng Google Workspace Business và Enterprise.
vault Báo cáo hoạt động trong Vault trả về thông tin về nhiều loại sự kiện hoạt động trong Vault.

Hoạt động

Mẫu JSON cho tài nguyên hoạt động.

Biểu diễn dưới dạng JSON 
{
  "kind": string,
  "etag": string,
  "ownerDomain": string,
  "ipAddress": string,
  "events": [
    {
      "type": string,
      "name": string,
      "parameters": [
        {
          "messageValue": {
            "parameter": [
              {
                object (NestedParameter)
              }
            ]
          },
          "name": string,
          "value": string,
          "multiValue": [
            string
          ],
          "intValue": string,
          "multiIntValue": [
            string
          ],
          "boolValue": boolean,
          "multiMessageValue": [
            {
              "parameter": [
                {
                  object (NestedParameter)
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "id": {
    "time": string,
    "uniqueQualifier": string,
    "applicationName": string,
    "customerId": string
  },
  "actor": {
    "profileId": string,
    "email": string,
    "callerType": string,
    "key": string
  }
}
Trường
kind

string

Loại tài nguyên API. Đối với báo cáo hoạt động, giá trị là audit#activity.
etag

string

ETag của mục nhập.
ownerDomain

string

Đây là miền chịu ảnh hưởng của sự kiện trong báo cáo. Ví dụ: miền của Bảng điều khiển dành cho quản trị viên hoặc chủ sở hữu tài liệu của ứng dụng Drive.
ipAddress

string

Địa chỉ IP của người dùng thực hiện hành động. Đây là địa chỉ Giao thức Internet (IP) của người dùng khi đăng nhập vào Google Workspace. Địa chỉ này có thể phản ánh hoặc không phản ánh vị trí thực tế của người dùng. Ví dụ: địa chỉ IP có thể là địa chỉ của máy chủ proxy của người dùng hoặc địa chỉ mạng riêng ảo (VPN). API này hỗ trợ IPv4 và IPv6.
events[]

object

Các sự kiện hoạt động trong báo cáo.
events[].type

string

Loại sự kiện. Dịch vụ hoặc tính năng của Google Workspace mà quản trị viên thay đổi được xác định trong tài sản type. Tài sản này xác định một sự kiện bằng tài sản eventName. Để biết danh sách đầy đủ các danh mục type của API, hãy xem danh sách tên sự kiện cho nhiều ứng dụng ở trên trong applicationName.
events[].name

string

Tên sự kiện. Đây là tên cụ thể của hoạt động do API báo cáo. Ngoài ra, mỗi eventName đều liên quan đến một dịch vụ hoặc tính năng cụ thể của Google Workspace mà API sắp xếp thành các loại sự kiện.
Nhìn chung, đối với các tham số yêu cầu eventName:

  • Nếu không có eventName nào được cung cấp, báo cáo sẽ trả về tất cả các thực thể có thể có của eventName.
  • Khi bạn yêu cầu eventName, phản hồi của API sẽ trả về tất cả hoạt động chứa eventName đó.

Để biết thêm thông tin về các thuộc tính eventName, hãy xem danh sách tên sự kiện cho nhiều ứng dụng ở trên trong applicationName.
events[].parameters[]

object

Các cặp giá trị thông số cho nhiều ứng dụng. Để biết thêm thông tin về các tham số eventName, hãy xem danh sách tên sự kiện cho nhiều ứng dụng ở trên trong applicationName.
events[].parameters[].messageValue

object

Các cặp giá trị thông số lồng nhau được liên kết với thông số này. Loại giá trị phức tạp cho một tham số được trả về dưới dạng danh sách các giá trị tham số. Ví dụ: tham số địa chỉ có thể có giá trị là [{parameter: [{name: city, value: abc}]}]
events[].parameters[].messageValue.parameter[]

object (NestedParameter)

Giá trị tham số
events[].parameters[].name

string

Tên của thông số.
events[].parameters[].value

string

Giá trị chuỗi của thông số.
events[].parameters[].multiValue[]

string

Giá trị chuỗi của tham số.
events[].parameters[].intValue

string (int64 format)

Giá trị số nguyên của tham số.
events[].parameters[].multiIntValue[]

string (int64 format)

Giá trị số nguyên của tham số.
events[].parameters[].boolValue

boolean

Giá trị boolean của thông số.
events[].parameters[].multiMessageValue[]

object

activities.list của các đối tượng messageValue.
events[].parameters[].multiMessageValue[].parameter[]

object (NestedParameter)

Giá trị thông số
id

object

Giá trị nhận dạng duy nhất của từng bản ghi hoạt động.
id.time

string

Thời gian diễn ra hoạt động. Dấu thời gian này được tính theo thời gian bắt đầu của hệ thống UNIX, tính bằng giây.
id.uniqueQualifier

string (int64 format)

Bộ hạn định duy nhất nếu nhiều sự kiện có cùng thời gian.
id.applicationName

string

Tên ứng dụng chứa sự kiện. Để biết các giá trị có thể có, hãy xem danh sách ứng dụng ở trên trong applicationName.
id.customerId

string

Giá trị nhận dạng duy nhất của một tài khoản Google Workspace.
actor

object

Người dùng thực hiện hành động.
actor.profileId

string

Mã hồ sơ Google Workspace duy nhất của người thực hiện. Giá trị này có thể không xuất hiện nếu người dùng không phải là người dùng Google Workspace hoặc có thể là số 105250506097979753968 đóng vai trò là mã nhận dạng phần giữ chỗ.
actor.email

string

Địa chỉ email chính của diễn viên. Có thể không có nếu không có địa chỉ email nào được liên kết với diễn viên.
actor.callerType

string

Loại đối tượng.
actor.key

string

Chỉ xuất hiện khi callerType là KEY. Có thể là consumer_key của bên yêu cầu đối với các yêu cầu API OAuth 2LO hoặc giá trị nhận dạng cho tài khoản rô-bốt.