API Báo cáo là một API RESTful mà bạn có thể dùng để truy cập vào thông tin về hoạt động của người dùng trên Google Workspace. API Báo cáo là một phần của API SDK dành cho quản trị viên.
API Báo cáo cung cấp hai loại báo cáo:
- Báo cáo Hoạt động giúp báo cáo các sự kiện cho một ứng dụng hoặc dịch vụ cụ thể, chẳng hạn như Google Drive hoặc Bảng điều khiển dành cho quản trị viên.
- Báo cáo Mức sử dụng liệt kê các sự kiện trong không gian làm việc do người dùng gây ra.
- Báo cáo sử dụng Khách hàng liệt kê các sự kiện cho tất cả người dùng trong miền của bạn.
- Báo cáo sử dụng Người dùng liệt kê các sự kiện được sắp xếp theo người dùng.
Sau đây là danh sách các thuật ngữ phổ biến được dùng trong API Báo cáo:
- Báo cáo hoạt động
Báo cáo hoạt động liệt kê thông tin về các hoạt động trong một ứng dụng hoặc dịch vụ cụ thể của Google Workspace. Báo cáo hoạt động bao gồm ngày, giờ, người dùng và loại hoạt động. Tài liệu tham khảo API chứa danh sách đầy đủ các báo cáo hoạt động và thông tin có trong các báo cáo đó. Dưới đây là một số ví dụ về báo cáo hoạt động được liệt kê theo ứng dụng hoặc dịch vụ:
- Báo cáo hoạt động của quản trị viên hiển thị các hoạt động do quản trị viên thực hiện bằng Bảng điều khiển dành cho quản trị viên. Ví dụ: bạn có thể xem danh sách tất cả các lần quản trị viên thay đổi tên của người dùng bằng Bảng điều khiển dành cho quản trị viên.
- Báo cáo hoạt động trên Google Drive liệt kê cách người dùng trong miền của bạn chỉnh sửa và xem tài liệu trên Drive của họ. Ví dụ: bạn có thể xem danh sách hoạt động của một người dùng cụ thể trên Drive.
- Báo cáo hoạt động đăng nhập cung cấp thông tin về thời điểm người dùng đăng nhập và đăng xuất khỏi tài khoản của họ. Chẳng hạn, bạn có thể nhận báo cáo về tất cả các lượt đăng nhập miền của mình trong một khoảng thời gian cụ thể.
- Báo cáo hoạt động trên thiết bị di động cho thấy các hoạt động sử dụng thiết bị di động do Google Mobile Management quản lý. Ví dụ: bạn có thể nhận được thông báo khi người dùng đăng ký một thiết bị mới.
- Báo cáo hoạt động liên quan đến mã thông báo OAuth liệt kê các sự kiện khi người dùng đã cấp hoặc thu hồi mã thông báo uỷ quyền mà các trang web và ứng dụng của bên thứ ba sử dụng. Bạn có thể sử dụng API Báo cáo để xem danh sách tất cả quyền truy cập của bên thứ ba vào dữ liệu Google Workspace của người dùng.
- Báo cáo sử dụng
Báo cáo sử dụng cung cấp thông tin về các sự kiện của Google Workspace trong miền của bạn. Bạn có thể sử dụng API này để yêu cầu thông tin cụ thể về người dùng.
- Báo cáo sử dụng của khách hàng liệt kê các hoạt động chi tiết về ứng dụng và dịch vụ trong tài khoản của bạn. Thông tin về việc sử dụng này được sắp xếp theo loại ứng dụng và chứa thông tin dành riêng cho ứng dụng đó.
- Báo cáo mức sử dụng của người dùng cho biết hoạt động của người dùng tài khoản. Bạn có thể tuỳ chỉnh và lọc những báo cáo này theo thông tin cụ thể về việc sử dụng. Thông tin về mức sử dụng này được sắp xếp theo loại ứng dụng và chứa thông tin dành riêng cho ứng dụng đó.
- Báo cáo sử dụng thực thể liệt kê các hoạt động liên quan đến những thực thể mà người dùng tài khoản của bạn sử dụng trong ứng dụng Currents.
- Thông báo
- API Báo cáo cung cấp các thông báo cho phép bạn theo dõi các sự kiện, chẳng hạn như các thay đổi đối với tài nguyên. Khi bạn đang xem một tài nguyên và tài nguyên đó thay đổi, API Báo cáo sẽ gửi cho bạn một thông báo. Để biết thêm thông tin về cách thiết lập và nhận thông báo từ API Báo cáo, hãy xem hướng dẫn về cách Nhận thông báo đẩy.
Các bước tiếp theo
Để tìm hiểu về API Báo cáo và cách hoạt động của API này, hãy sử dụng Quickstart (khởi động nhanh) được liệt kê theo ngôn ngữ lập trình ở thanh điều hướng bên trái. Bạn cũng có thể tiếp tục qua phần này để đọc thông tin chung về cách thiết lập tài khoản của mình.
Phần uỷ quyền cho bạn biết cách sử dụng mã truy cập OAuth 2.0 để lấy dữ liệu người dùng từ các ứng dụng và dịch vụ của Google Workspace.
Để tìm thông tin chi tiết về một loại tài nguyên hoặc phương thức cụ thể, hãy xem Tài liệu tham khảo API.
Để biết thêm thông tin, hãy xem Công cụ theo dõi lỗi của API SDK dành cho quản trị viên, Blog dành cho nhà phát triển trên Google Workspace và Trung tâm trợ giúp dành cho Quản trị viên Google Workspace.