Trang này được dịch bởi Cloud Translation API.

Method: activities.watch

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
- Biểu diễn dưới dạng JSON
Phạm vi cấp phép
ApplicationName

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

Thông số

Thông số
`userKey or all`	`string` 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à `all` cho tất cả thông tin hoặc `userKey` cho mã nhận dạng hồ sơ duy nhất của người dùng trên Google Workspace 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` đã trả về làm `userKey`.
`applicationName`	`enum (ApplicationName)` Tên ứng dụng mà bạn muốn truy xuất các sự kiện.

userKey or all

string

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à all cho tất cả thông tin hoặc userKey cho mã nhận dạng hồ sơ duy nhất của người dùng trên Google Workspace 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 đã trả về làm userKey.

applicationName

enum (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`	`string` Đị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`	`string` Mã nhận dạng duy nhất của khách hàng để truy xuất dữ liệu.
`endTime`	`string` Đặ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: Ngày API yêu cầu báo cáo: Khi 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 xuất hiện 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 khoảng thời gian xuất hiện 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 thân báo cáo có thể được yêu cầu vào tháng 8. Nếu bạn không chỉ định `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.
`eventName`	`string` Tên của sự kiện mà API đang truy vấn. 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. 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 Chế độ cài đặt lịch `type` có tất cả các hoạt động của Lịch `eventName` 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 các tham số `type` và `eventName` của Chế độ cài đặt Lịch. Để biết thêm thông tin về các thông số và chuỗi truy vấn `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ử quan hệ 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ể. Một báo cáo trống sẽ được trả về 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 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ả các sự kiện `edit` trong đó giá trị tham số `doc_id` khớp với các điều kiện do toán tử quan hệ xác định. Trong ví dụ đầu tiên, yêu cầu này trả về tất cả cá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 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` Một truy vấn `filters` hỗ trợ các toán tử quan hệ 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 được mã hoá URL (%3E). `>=` – "lớn hơn hoặc bằng". Phải được mã hoá URL (%3E=). 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`	`integer` 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 `maxResults=1` và báo cáo có 2 hoạt động, thì báo cáo sẽ có 2 trang. Thuộc tính `nextPageToken` của phản hồi có mã thông báo cho trang thứ hai. Bạn không bắt buộc phải dùng chuỗi truy vấn `maxResults` trong yêu cầu. Giá trị mặc định là 1000.
`orgUnitID (deprecated)`	`string` `Deprecated`. Trường này không còn dùng nữa và không còn được hỗ trợ. 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. Dữ liệu trước ngày 17 tháng 12 năm 2018 không xuất hiện trong kết quả được 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ó một thuộc tính `nextPageToken` trong phản hồi. Trong yêu cầu tiếp theo để lấy 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 đ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 `startTime` đến ngày `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 (deprecated)`	`string` `Deprecated`. Trường này không còn dùng nữa và không còn được hỗ trợ. 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" Lưu ý quan trọng: Để lọc theo nhóm, bạn phải thêm các nhóm một cách rõ ràng vào danh sách cho phép lọc theo nhóm. Để biết thêm thông tin về cách thêm nhóm vào danh sách cho phép nhóm lọc, hãy xem phần Lọc kết quả theo Nhóm Google

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 }

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` Một UUID hoặc chuỗi duy nhất tương tự dùng để xác định kênh này.
`token`	`string` Một chuỗi tuỳ ý được gửi đến địa chỉ đích cùng với mỗi thông báo được gử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ỉ nhận thông báo 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 POST, PUT hoặc PATCH qua HTTP 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` Mã nhận dạng 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 dành riêng cho phiên bản của tài nguyên được theo dõi.
`kind`	`string` 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, đó 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