Method: userProfiles.checkUserCapability

Trả về thông tin về việc người dùng có thể sử dụng tính năng Lớp học đã chỉ định hay không. Ví dụ: bạn có thể dùng điểm cuối này để kiểm tra xem người dùng có thể tạo tệp đính kèm tiện ích bổ sung hay không.

Người dùng yêu cầu chỉ có thể kiểm tra các chức năng cho chính mình.

Phương thức này trả về các mã lỗi sau:

  • PERMISSION_DENIED nếu người dùng yêu cầu không được phép kiểm tra điều kiện của người dùng được chỉ định.
  • INVALID_ARGUMENT nếu yêu cầu không đúng định dạng.

Yêu cầu HTTP

GET https://classroom.googleapis.com/v1/userProfiles/{userId}:checkUserCapability

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Thông số
userId

string

Bắt buộc. Giá trị nhận dạng của người dùng.

Khi được chỉ định làm tham số của một yêu cầu, giá trị nhận dạng này có thể là một trong những giá trị sau:

  • giá trị nhận dạng dạng số của người dùng
  • địa chỉ email của người dùng
  • chuỗi cố định "me", cho biết người dùng yêu cầu

Tham số truy vấn

Thông số
capability

enum (Capability)

Bắt buộc. Chức năng cần được kiểm tra đối với người dùng này. Ví dụ: để kiểm tra xem người dùng có thể tạo tệp đính kèm bằng tiện ích bổ sung hay không, hãy đặt giá trị này thành CREATE_ADD_ON_ATTACHMENT.
previewVersion

enum (PreviewVersion)

Không bắt buộc. Phiên bản xem trước của API.

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

Phản hồi từ việc kiểm tra chức năng của người dùng.

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 
{
  "capability": enum (Capability),
  "allowed": boolean
}
Trường
capability

enum (Capability)

Chức năng của Lớp học.
allowed

boolean

Liệu người dùng có được phép sử dụng chức năng đã chỉ định hay không.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

Chức năng

Enum để biểu thị chức năng.

Enum
CAPABILITY_UNSPECIFIED Không được hỗ trợ.
CREATE_ADD_ON_ATTACHMENT Khả năng tạo và sửa đổi AddOnAttach được liên kết với dự án Developer Console của ID ứng dụng OAuth được dùng để đưa ra yêu cầu.
UPDATE_GRADING_PERIOD_SETTINGS Khả năng sửa đổi chế độ cài đặt giai đoạn chấm điểm.