Method: activities.watch

• Yêu cầu HTTP
• Thông số đường dẫn
• Tham số truy vấn
• Nội dung yêu cầu
• Nội dung phản hồi
  • Biểu diễn dưới dạng JSON
• Phạm vi uỷ quyền
• ApplicationName

Bắt đầu nhận thông báo về hoạt động 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

Thông số
userKey	string Biểu thị mã hồ sơ hoặc email 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 Directory API bằng showDeleted=true, sau đó sử dụng ID được trả về làm userKey.
applicationName	enum (ApplicationName) Tên ứng dụng cần truy xuất sự kiện.

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 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 ướ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: 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 chế độ cài đặt Lịch, API sẽ báo cáo hoạt động này trong các thông số Chế độ cài đặt Lịch type và 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. Cá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 hiện có cho từng ứng dụng và các thông 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 cho ứng dụng 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 mà 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 là URL được mã hoá (%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 được mã hoá URL (%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, hàm sẽ trả về tất cả các tham số.
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 (deprecated)	string Deprecated. Trường này không dùng được nữa và không còn được hỗ trợ nữa. Mã nhận dạng của đơn vị tổ chức mà bạn muốn báo cáo. Chỉ những người dùng thuộc đơn vị tổ chức được chỉ định mới thấy bản ghi hoạt động. Dữ liệu trước ngày 17 tháng 12 năm 2018 sẽ không xuất hiện trong kết quả đã lọc.
pageToken	string 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 nextPageToken trong phản hồi. Trong yêu cầu tiếp theo của bạn về việc 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 chứa một bản sao của SubscriptionChannel.

Nội dung phản hồi

Một 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	string UUID hoặc chuỗi duy nhất tương tự giúp xác định kênh này.
token	string Một chuỗi tuỳ ý được phân phối đến địa chỉ mục tiêu cùng với mỗi thông báo được phân phối qua kênh này. Không bắt buộc.
expiration	string (int64 format) Ngày và giờ hết hạn của kênh thông báo, được biểu thị dưới dạng dấu thời gian Unix, tính bằng mili giây. Không bắt buộc.
type	string Loại cơ chế phân phối được dùng cho kênh này. Bạn phải đặt giá trị là "web_hook".
address	string Địa chỉ nơi thông báo được gửi cho kênh này.
payload	boolean 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	map (key: string, value: string) 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 "key": value. Ví dụ: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
resourceId	string 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	string Giá trị nhận dạng theo phiên bản cho tài nguyên được theo dõi.
kind	string Xác định đây là kênh thông báo dùng để theo dõi các thay đổi đối với một tài nguyên, đó là "api#channel".

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 cần truy xuất sự kiện.

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ỉ đượ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 trên 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ề 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ề 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ề các loại Sự kiện hoạt động đăng nhập khác nhau.
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 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ề 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.