- 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 cấp phép
- ApplicationName
- Hoạt động
- NetworkInfo
- 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 một tài khoản và ứng dụng cụ thể của khách hàng, 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ề các 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 người dùng mà dữ liệu cần được lọc. Có thể là |
applicationName |
Tên ứng dụng mà bạn muốn truy xuất các 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 diễn ra sự kiện. Đây là một cách khác để lọc thông tin 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ỉ 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 điểm cuối của phạm vi thời gian xuất hiện 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ó 3 khái niệm cơ bản về thời gian:
endTime , thì 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 đây hơn 180 ngày. Đối với yêu cầu liên quan đến Gmail, bạn phải cung cấp startTime và endTime , đồng thời khoảng cách giữa hai ngày này không được quá 30 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ả các sự kiện
Một truy vấn
Lưu ý: API này 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, thì tất cả tham số sẽ được trả về. |
maxResults |
Xác định số lượng bản ghi hoạt động xuất hiện 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 cần báo cáo. Hồ sơ hoạt động sẽ chỉ xuất hiện 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ó một thuộc tính |
startTime |
Đặt điểm bắt đầu của phạm vi thời gian xuất hiện trong báo cáo. Ngày ở định dạng RFC 3339, ví dụ: 2010-10-28T10:26:35.000Z. Báo cáo này trả về tất cả hoạt động từ ngày |
groupIdFilter |
Mã nhận dạng nhóm (được che giấu) phân tách bằng dấu phẩy mà hoạt động của người dùng được lọc, 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ề 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. |
gmail |
Báo cáo hoạt động của ứng dụng Gmail trả về thông tin về nhiều sự kiện hoạt động trên Gmail. |
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 của Nhóm. |
groups_enterprise |
Báo cáo hoạt động của Nhóm doanh nghiệp trả về thông tin về nhiều sự kiện hoạt động của Nhóm doanh nghiệp. |
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ề các 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ề nhiều loại sự kiện Kiểm tra hoạt động trên Meet. |
mobile |
Báo cáo hoạt động Kiểm tra thiết bị trả về thông tin về nhiều 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ề nhiều loại sự kiện hoạt động SAML. |
token |
Báo cáo hoạt động của ứng dụng Token trả về thông tin tài khoản về nhiều loại Sự kiện hoạt động của Token. |
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 của Tài khoản người dùng. |
context_aware_access |
Báo cáo hoạt động Quyền truy cập theo bối cảnh trả về thông tin về các sự kiện bị từ chối truy cập của người dùng do quy tắc Quyền 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 của Vault trả về thông tin về nhiều loại sự kiện hoạt động của Vault. |
gemini_in_workspace_apps |
Báo cáo hoạt động của Gemini cho Workspace trả về thông tin về nhiều loại sự kiện hoạt động của Gemini do người dùng thực hiện trong một ứng dụng của Workspace. |
classroom |
Báo cáo hoạt động trên Lớp học trả về thông tin về nhiều loại sự kiện hoạt động trên Lớp học. |
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ỉ 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[] |
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 của Google Workspace mà quản trị viên thay đổi được xác định trong thuộc tính |
events[].name |
Tên của sự kiện. Đây là tên cụ thể của hoạt động do API báo cáo. 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ị tham 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ị kiểu chuỗi của thông số. |
events[].parameters[].multiValue[] |
Giá trị chuỗi của thông số. |
events[].parameters[].intValue |
Giá trị số nguyên của thông số. |
events[].parameters[].multiIntValue[] |
Giá trị số nguyên của tham số. |
events[].parameters[].boolValue |
Giá trị boolean của thông số. |
events[].parameters[].multiMessageValue[] |
activities.list gồm 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 riêng biệt cho từng bản ghi hoạt động. |
id.time |
Thời gian diễn ra hoạt động. Đây là thời gian bắt đầu của hệ thống UNIX tính bằng giây. |
id.uniqueQualifier |
Giá trị phân biệt duy nhất nếu nhiều sự kiện có cùng thời gian. |
id.applicationName |
Tên ứng dụng mà sự kiện thuộc về. Để 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 cho một tài khoản Google Workspace. |
actor |
Người dùng thực hiện hành động. |
actor.profileId |
Mã nhận dạng 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 tác nhân 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 người thực hiện. |
actor.key |
Chỉ xuất hiện khi |
actor.applicationInfo |
Thông tin chi tiết về ứng dụng là đối tượng thực hiện hoạt động. |
actor.applicationInfo.oauthClientId |
Mã ứng dụng OAuth của ứng dụng bên thứ ba được dùng để thực hiện hành động. |
actor.applicationInfo.applicationName |
Tên của ứng dụng dùng để thực hiện thao tác. |
actor.applicationInfo.impersonation |
Ứng dụng có mạo danh người dùng hay không. |
networkInfo |
Thông tin mạng của người dùng thực hiện hành động. |
resourceDetails[] |
Thông tin chi tiết về tài nguyên mà hành động được thực hiện. |
NetworkInfo
Thông tin mạng của người dùng thực hiện hành động.
Biểu diễn dưới dạng JSON |
---|
{ "ipAsn": [ integer ], "regionCode": string, "subdivisionCode": string } |
Trường | |
---|---|
ipAsn[] |
Địa chỉ IP của người dùng thực hiện hành động. |
regionCode |
Mã vùng ISO 3166-1 alpha-2 của người dùng thực hiện hành động. |
subdivisionCode |
Mã vùng ISO 3166-2 (tiểu bang và tỉnh) cho quốc gia của người dùng thực hiện hành động. |
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 là một 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 dạng nhãn, không phải tên tài nguyên đầy đủ của OnePlatform. |
title |
Tiêu đề của nhãn |
fieldValues[] |
activities.list of fields which are part of the label and have been set by the user. Nếu nhãn có một trường mà người dùng chưa đặt, thì nhãn đó sẽ không xuất hiện trong danh sách này. |
reason |
Lý do nhãn được áp dụng 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 trường này được áp dụng cho nhãn. |
Trường nhóm value . 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, thì giá trị sẽ là true. |
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 một trình đơn 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 duy nhất. |
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 of text values. |
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 |
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 một trình đơn 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 duy nhất.
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 of users. |
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 Dương lịch. Nội dung đặc tả này có thể xuất hiện dưới dạng một trong những nội dung 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 giá trị 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 giá trị 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 từ 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 nếu chỉ 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. |