- 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
Bắt đầu nhận thông báo về các hoạt động của tài khoản. Để biết thêm thông tin, hãy xem bài viết Nhận thông báo đẩy.
Yêu cầu HTTP
POST https://admin.googleapis.com/admin/reports/v1/activity/users/{userKey or all}/applications/{applicationName}/watch
URL sử dụng cú pháp Chuyển mã gRPC.
Tham số đường dẫn
Tham số | |
---|---|
userKey or all |
Biểu thị mã hồ sơ hoặc email người dùng mà dữ liệu sẽ được lọc. Có thể là |
applicationName |
Tên ứng dụng mà các sự kiện cần được truy xuất. |
Tham số truy vấn
Tham 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 một 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 cần truy xuất dữ liệu. |
endTime |
Đặt thời gian kết thúc của khoảng 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 cơ bản về thời gian:
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 đã vượt quá 180 ngày trước đó.
|
eventName |
Tên của sự kiện đang được API 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ụ về hoạt động trên Drive sau đây, 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 thông số được cung cấp nhiều lần trong yêu cầu API, thì API chỉ chấp nhận giá trị mới nhất của thông 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, hàm sẽ trả về tất cả các tham số. |
maxResults |
Xác định số lượng bản ghi hoạt động được hiển thị trên mỗi trang phản hồi. Ví dụ: nếu yêu cầu đặt |
orgUnitID |
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 |
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 |
startTime |
Đặt thời điểm bắt đầu 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 này trả về tất cả hoạt động từ |
groupIdFilter |
Mã nhóm được phân tách bằng dấu phẩy (bị làm rối mã nguồn) mà các hoạt động của người dùng được lọc, tức là nội dung phản hồi sẽ chỉ chứa các hoạt động dành cho 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 chứa một bản sao của SubscriptionChannel
.
Nội dung phản hồi
Kênh thông báo dùng để theo dõi các thay đổi về tài nguyên.
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 |
---|
{ "id": string, "token": string, "expiration": string, "type": string, "address": string, "payload": boolean, "params": { string: string, ... }, "resourceId": string, "resourceUri": string, "kind": string } |
Trường | |
---|---|
id |
Mã nhận dạng duy nhất (UUID) hoặc chuỗi duy nhất tương tự xác định kênh này. |
token |
Một chuỗi tuỳ ý được gửi tới địa chỉ đích, trong đó mỗi thông báo được gửi qua kênh này. Không bắt buộc. |
expiration |
Ngày và thời gian hết hạn kênh thông báo, được biểu thị bằng dấu thời gian Unix, tính bằng mili giây. Không bắt buộc. |
type |
Loại cơ chế phân phối được sử dụng cho kênh này. Bạn phải đặt giá trị là |
address |
Địa chỉ nhận thông báo cho kênh này. |
payload |
Giá trị Boolean để cho biết liệu có cần tải trọng hay không. Tải trọng là dữ liệu được gửi trong phần nội dung của thông báo HTTP POST, PUT hoặc PATCH và chứa thông tin quan trọng về yêu cầu. Không bắt buộc. |
params |
Các tham số bổ sung kiểm soát hành vi của kênh phân phối. Không bắt buộc. Một đối tượng chứa danh sách các cặp |
resourceId |
ID mờ xác định tài nguyên đang được xem trên kênh này. Ổn định trên nhiều phiên bản API. |
resourceUri |
Giá trị nhận dạng theo phiên bản cụ thể của tài nguyên được xem. |
kind |
Xác định đây là một kênh thông báo dùng để theo dõi các thay đổi đối với một tài nguyên, tức là " |
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
Tên ứng dụng mà các sự kiện cần được truy xuất.
Enum | |
---|---|
access_transparency |
Báo cáo hoạt động Thông tin minh bạch về việc truy cập của Google Workspace trả về thông tin về các loại sự kiện hoạt động liên quan đến Thông tin minh bạch về việc truy cập. |
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 liên quan đến các loại sự kiện hoạt động của quản trị viên khác nhau. |
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 trong Chat trả về thông tin về nhiều sự kiện hoạt động trong Chat. |
drive |
Báo cáo hoạt động của ứng dụng Google Drive trả về thông tin về các sự kiện hoạt động trên Google Drive. Báo cáo hoạt động trên Drive chỉ được cung cấp cho khách hàng Google Workspace Business và Google Workspace 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 GCP. |
gplus |
Báo cáo hoạt động của ứng dụng Google+ trả về thông tin về các sự kiện hoạt động khác nhau trên Google+. |
groups |
Báo cáo hoạt động của ứng dụng Google Groups trả về thông tin về các sự kiện hoạt động của Groups. |
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ề các 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 trong Meet trả về thông tin về các loại sự kiện hoạt động Kiểm tra trên 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ị khác nhau. |
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 khác nhau. |
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 liên quan đến nhiều loại sự kiện hoạt động của 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 theo nhiều loại sự kiện hoạt động 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ề người dùng các sự kiện bị từ chối truy cập do các quy tắc về 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 của trình duyệt Chrome và ChromeOS. |
data_studio |
Báo cáo hoạt động trên Data Studio trả về thông tin về nhiều loại sự kiện hoạt động trên 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 trong Keep chỉ được cung cấp cho khách hàng Google Workspace Business và Enterprise. |