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 相關聯的 Developer Console 專案 AddOnAttachment。
CREATE_RUBRIC 建立及修改評量標準的功能。
UPDATE_GRADING_PERIOD_SETTINGS 修改評分期間設定的功能。