Method: userProfiles.checkUserCapability

傳回使用者是否可使用指定的 Classroom 功能。舉例來說，這個端點可用於檢查使用者是否可以建立外掛程式附件。

要求存取權的使用者只能查看自己的功能。

這個方法會傳回下列錯誤代碼：

  • PERMISSION_DENIED 如果要求的使用者無權檢查指定使用者的資格。
  • INVALID_ARGUMENT：要求格式錯誤。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
userId

string

必要欄位。使用者的 ID。

指定為要求參數時，這個 ID 可以是下列其中一項：

  • 使用者的數字 ID
  • 使用者的電子郵件地址
  • 字串常值 "me"，表示要求的使用者

查詢參數

參數
capability

enum (Capability)

必要欄位。應為這位使用者檢查的功能。舉例來說，如要檢查使用者是否可以建立外掛程式附件，請將這個值設為 CREATE_ADD_ON_ATTACHMENT。
previewVersion

enum (PreviewVersion)

(選用步驟) API 的預覽版本。

要求主體

要求主體必須為空白。

回應主體

檢查使用者功能的回應。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "capability": enum (Capability),
  "allowed": boolean
}
欄位
capability

enum (Capability)

Classroom 功能。
allowed

boolean

使用者是否可使用指定功能。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱授權指南。

功能

列舉表示功能。

列舉
CAPABILITY_UNSPECIFIED 不支援。
CREATE_ADD_ON_ATTACHMENT 有權建立及修改與 OAuth 用戶端 ID 相關聯的 AddOnAttachments，該 ID 用於提出要求。
CREATE_RUBRIC 建立及修改評量表的功能。
UPDATE_GRADING_PERIOD_SETTINGS 修改評分週期設定的功能。
CREATE_STUDENT_GROUP 建立及修改學生群組和成員。