Truy xuất báo cáo là tập hợp các thuộc tính và số liệu thống kê cho một nhóm người dùng có tài khoản. Để biết thêm thông tin, hãy xem Hướng dẫn về Báo cáo sử dụng của người dùng. Để biết thêm thông tin về các thông số của báo cáo người dùng, hãy xem hướng dẫn tham khảo về Thông số sử dụng của người dùng.
Yêu cầu HTTP
GET https://admin.googleapis.com/admin/reports/v1/usage/users/{userKey or all}/dates/{date}
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 API Thư mục với showDeleted=true, sau đó sử dụng ID được trả về làm userKey.
date
string
Thể hiện ngày sử dụng dựa trên UTC-8:00 (Giờ chuẩn Thái Bình Dương). Dấu thời gian ở định dạng ISO 8601, yyyy-mm-dd.
Tham số truy vấn
Tham số
customerId
string
Mã nhận dạng duy nhất của khách hàng cần truy xuất dữ liệu.
filters
string
Chuỗi truy vấn filters là một danh sách các tham số sự kiện của ứng dụng được phân tách bằng dấu phẩy, trong đó giá trị của tham số được thao tác bởi một toán tử quan hệ. Chuỗi truy vấn filters bao gồm tên của ứng dụng có hoạt động sử dụng được trả về trong báo cáo. Các giá trị của ứng dụng cho Báo cáo mức sử dụng của người dùng bao gồm accounts, docs và gmail.
Các bộ lọc có dạng [application name]:[parameter
name][relational operator][parameter value],....
Trong ví dụ này, <> "không bằng" được mã hoá URL trong chuỗi truy vấn của yêu cầu (%3C%3E):
GET
https://www.googleapis.com/admin/reports/v1/usage/users/all/dates/2013-03-03
?parameters=accounts:last_login_time
&filters=accounts:last_login_time%3C%3E2010-10-28T10:26:35.000Z
Các toán tử quan hệ bao gồm:
== – "bằng".
<> – "không bằng". Đó là URL được mã hoá (%3C%3E).
< – "nhỏ hơn". Đó là URL được mã hoá (%3C).
<= – "nhỏ hơn hoặc bằng". Đó là URL được mã hoá (%3C=).
> – "lớn hơn". Đó là URL được mã hoá (%3E).
>= – "lớn hơn hoặc bằng". Đó là URL được mã hoá (%3E=).
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 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 cho trang thứ hai. Chuỗi truy vấn maxResults là không bắt buộc.
orgUnitID
string
Mã của đơn vị tổ chức mà bạn muốn báo cáo. Hoạt động của người dùng sẽ chỉ hiển thị cho người dùng thuộc đơn vị tổ chức được chỉ định.
pageToken
string
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 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.
parameters
string
Chuỗi truy vấn parameters là danh sách các thông số sự kiện được phân tách bằng dấu phẩy giúp tinh chỉnh kết quả của báo cáo. Tham số này được liên kết với một ứng dụng cụ thể. Các giá trị ứng dụng trong Báo cáo về việc sử dụng của khách hàng bao gồm accounts, app_maker, apps_scripts, calendar, classroom, cros, docs, gmail, gplus, device_management, meet và sites. Chuỗi truy vấn parameters ở dạng CSV app_name1:param_name1, app_name2:param_name2.
groupIdFilter
string
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 phải trống.
Nội dung phản hồi
Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của UsageReports.