- Yêu cầu HTTP
- Tham số đường dẫn
- Tham số truy vấn
- Nội dung yêu cầu
- Nội dung phản hồi
- Phạm vi uỷ quyền
- ApplicationName
- Hoạt động
- ResourceDetails
- AppliedLabel
- FieldValue
- TextListValue
- SelectionValue
- SelectionListValue
- UserValue
- UserListValue
- Ngày
- Lý do
- Hãy làm thử!
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 or all |
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à |
applicationName |
Tên ứng dụng cần truy xuất sự kiện. |
Tham số truy vấn
Thông số | |
---|---|
actorIpAddress |
Đị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 |
Mã nhận dạng duy nhất của khách hàng để truy xuất dữ liệu. |
endTime |
Đặ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 ước chừ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:
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 |
Tên của sự kiện mà API đang truy vấn. Mỗi |
filters |
Chuỗi truy vấn Các thông số sự kiện này được liên kết với một 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
Truy vấn
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 |
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 |
orgUnitID |
Mã nhận dạng của đơn vị tổ chức mà bạn muốn báo cáo. Nhật ký hoạt động sẽ chỉ hiển thị cho những người dùng thuộc đơn vị tổ chức được chỉ định. |
pageToken |
Mã thông báo để chỉ định trang tiếp theo. Báo cáo có nhiều trang sẽ có thuộc tính |
startTime |
Đặ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ừ |
groupIdFilter |
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 ( |
Trường | |
---|---|
kind |
Loại tài nguyên API. Đối với báo cáo hoạt động, giá trị là |
etag |
ETag của tài nguyên. |
items[] |
Mỗi bản ghi hoạt động trong phản hồi. |
nextPageToken |
Mã thông báo để truy xuất trang tiếp theo của báo cáo. Giá trị |
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ề các 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 sử dụ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ề nhiều 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 bối 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 bối cảnh. |
chrome |
Báo cáo hoạt động trên Chrome trả về thông tin về các sự kiện trên trình duyệt Chrome và Chrome OS. |
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ề nhiều 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. |
gemini_in_workspace_apps |
Báo cáo hoạt động của Gemini trong các ứng dụng Workspace trả về thông tin về nhiều loại sự kiện hoạt động của Gemini mà người dùng thực hiện trong một ứng dụng Workspace. |
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 ( |
Trường | |
---|---|
kind |
Loại tài nguyên API. Đối với báo cáo hoạt động, giá trị là |
etag |
ETag của mục nhập. |
ownerDomain |
Đâ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 |
Đị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[] |
Các sự kiện hoạt động trong báo cáo. |
events[].type |
Loại sự kiện. Dịch vụ hoặc tính năng Google Workspace mà quản trị viên thay đổi được xác định trong thuộc tính |
events[].name |
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
Để 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[] |
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ố |
events[].parameters[].messageValue |
Các cặp giá trị tham số lồng nhau được liên kết với tham 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à |
events[].parameters[].messageValue.parameter[] |
Giá trị tham số |
events[].parameters[].name |
Tên của thông số. |
events[].parameters[].value |
Giá trị chuỗi của thông số. |
events[].parameters[].multiValue[] |
Giá trị chuỗi của tham số. |
events[].parameters[].intValue |
Giá trị số nguyên của tham số. |
events[].parameters[].multiIntValue[] |
Giá trị số nguyên của tham số. |
events[].parameters[].boolValue |
Giá trị boolean của tham số. |
events[].parameters[].multiMessageValue[] |
activities.list của các đối tượng |
events[].parameters[].multiMessageValue[].parameter[] |
Giá trị tham số |
events[].resourceIds[] |
Mã nhận dạng tài nguyên được liên kết với sự kiện. |
id |
Giá trị nhận dạng duy nhất của mỗi bản ghi hoạt động. |
id.time |
Thời gian xảy 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 |
Bộ hạn định duy nhất nếu nhiều sự kiện có cùng thời gian. |
id.applicationName |
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 |
id.customerId |
Giá trị nhận dạng duy nhất của một tài khoản Google Workspace. |
actor |
Người dùng thực hiện hành động. |
actor.profileId |
Mã hồ sơ Google Workspace duy nhất của người dùng. 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 |
Đị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 liên kết với diễn viên. |
actor.callerType |
Loại đối tượng. |
actor.key |
Chỉ xuất hiện khi |
actor.applicationInfo |
Thông tin chi tiết về ứng dụng là tác nhân của hoạt động. |
actor.applicationInfo.oauthClientId |
Mã ứng dụng khách OAuth của ứng dụng bên thứ ba dùng để thực hiện hành động. |
actor.applicationInfo.applicationName |
Tên ứng dụng dùng để thực hiện hành động. |
actor.applicationInfo.impersonation |
Liệu ứng dụng có mạo danh người dùng hay không. |
resourceDetails[] |
Thông tin chi tiết về tài nguyên mà hành động đã được thực hiện. |
ResourceDetails
Thông tin chi tiết về tài nguyên mà hành động đã được thực hiện.
Biểu diễn dưới dạng JSON |
---|
{
"id": string,
"title": string,
"type": string,
"appliedLabels": [
{
object ( |
Trường | |
---|---|
id |
Giá trị nhận dạng của tài nguyên. |
title |
Tiêu đề của tài nguyên. Ví dụ: trong trường hợp tài liệu trên Drive, đây sẽ là tiêu đề của tài liệu. Trong trường hợp là email, đây sẽ là tiêu đề. |
type |
Loại tài nguyên – tài liệu, email, tin nhắn trò chuyện |
appliedLabels[] |
activities.list of labels applied on the resource |
relation |
Xác định mối quan hệ của tài nguyên với các sự kiện |
AppliedLabel
Thông tin chi tiết về nhãn được áp dụng cho tài nguyên.
Biểu diễn dưới dạng JSON |
---|
{ "id": string, "title": string, "fieldValues": [ { object ( |
Trường | |
---|---|
id |
Giá trị nhận dạng của nhãn – Chỉ mã nhãn, không phải toàn bộ tên tài nguyên OnePlatform. |
title |
Tiêu đề của nhãn |
fieldValues[] |
activities.list các trường thuộc nhãn và do người dùng đặt. Nếu nhãn có một trường không do người dùng đặt, thì trường đó sẽ không xuất hiện trong danh sách này. |
reason |
Lý do áp dụng nhãn cho tài nguyên. |
FieldValue
Thông tin chi tiết về giá trị trường do người dùng đặt cho nhãn cụ thể.
Biểu diễn dưới dạng JSON |
---|
{ "id": string, "displayName": string, "type": string, "reason": { object ( |
Trường | |
---|---|
id |
Giá trị nhận dạng của trường |
displayName |
Tên hiển thị của trường |
type |
Loại trường |
reason |
Lý do áp dụng trường cho nhãn. |
Trường hợp hợp nhất value . Lưu trữ các giá trị được lưu trữ trong trường value chỉ có thể là một trong những giá trị sau: |
|
unsetValue |
Nếu bạn không đặt trường này, giá trị sẽ là đúng. |
longTextValue |
Đặt giá trị văn bản dài. |
textValue |
Đặt giá trị văn bản. |
textListValue |
Đặt giá trị danh sách văn bản. |
selectionValue |
Đặt giá trị lựa chọn bằng cách chọn một giá trị duy nhất trong trình đơn thả xuống. |
selectionListValue |
Đặt giá trị danh sách lựa chọn bằng cách chọn nhiều giá trị trong danh sách thả xuống. |
integerValue |
Đặt giá trị số nguyên. |
userValue |
Đặt giá trị người dùng bằng cách chọn một người dùng. |
userListValue |
Đặt giá trị danh sách người dùng bằng cách chọn nhiều người dùng. |
dateValue |
Đặt giá trị ngày. |
TextListValue
Đặt giá trị danh sách văn bản.
Biểu diễn dưới dạng JSON |
---|
{ "values": [ string ] } |
Trường | |
---|---|
values[] |
activities.list các giá trị văn bản. |
SelectionValue
Đặt giá trị lựa chọn bằng cách chọn một giá trị duy nhất trong trình đơn thả xuống.
Biểu diễn dưới dạng JSON |
---|
{ "id": string, "displayName": string, "badged": boolean } |
Trường | |
---|---|
id |
Giá trị nhận dạng của lựa chọn. |
displayName |
Tên hiển thị của lựa chọn. |
badged |
Liệu lựa chọn có được gắn huy hiệu hay không. |
SelectionListValue
Đặt giá trị danh sách lựa chọn bằng cách chọn nhiều giá trị trong danh sách thả xuống.
Biểu diễn dưới dạng JSON |
---|
{
"values": [
{
object ( |
Trường | |
---|---|
values[] |
activities.list of selections. |
UserValue
Đặt giá trị người dùng bằng cách chọn một người dùng.
Biểu diễn dưới dạng JSON |
---|
{ "email": string } |
Trường | |
---|---|
email |
Email của người dùng. |
UserListValue
Đặt giá trị danh sách người dùng bằng cách chọn nhiều người dùng.
Biểu diễn dưới dạng JSON |
---|
{
"values": [
{
object ( |
Trường | |
---|---|
values[] |
activities.list của người dùng. |
Ngày
Đại diện cho toàn bộ hoặc một phần ngày theo lịch, chẳng hạn như ngày sinh nhật. Thời gian trong ngày và múi giờ được chỉ định ở nơi khác hoặc không quan trọng. Ngày này có liên quan đến Lịch Gregorian. Giá trị này có thể biểu thị một trong những giá trị sau:
- Một ngày đầy đủ, với các giá trị năm, tháng và ngày khác 0.
- Tháng và ngày, với năm bằng 0 (ví dụ: ngày kỷ niệm).
- Chỉ riêng giá trị năm, với giá trị tháng và ngày bằng 0.
- Năm và tháng, với ngày bằng 0 (ví dụ: ngày hết hạn thẻ tín dụng).
Các loại có liên quan:
google.type.TimeOfDay
google.type.DateTime
google.protobuf.Timestamp
Biểu diễn dưới dạng JSON |
---|
{ "year": integer, "month": integer, "day": integer } |
Trường | |
---|---|
year |
Năm của ngày. Giá trị phải từ 1 đến 9999 hoặc bằng 0 để chỉ định ngày không có năm. |
month |
Tháng trong năm. Giá trị phải từ 1 đến 12 hoặc bằng 0 để chỉ định một năm không có tháng và ngày. |
day |
Ngày trong tháng. Giá trị phải từ 1 đến 31 và có giá trị trong năm và tháng, hoặc bằng 0 để chỉ định giá trị năm, hoặc một năm và tháng, trong đó ngày là không quan trọng. |
Lý do
Lý do áp dụng nhãn/trường.
Biểu diễn dưới dạng JSON |
---|
{ "reasonType": string } |
Trường | |
---|---|
reasonType |
Loại lý do. |