Method: userProfiles.checkUserCapability

返回用户是否可以使用指定的 Google 课堂功能。例如，此端点可用于检查用户是否可以创建插件附件。

发出请求的用户只能自行检查功能。

此方法会返回以下错误代码：

  • 如果发出请求的用户无权检查指定用户的资格，则为 PERMISSION_DENIED。
  • 如果请求格式不正确，则返回 INVALID_ARGUMENT。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
userId

string

必需。用户的标识符。

当指定为请求的参数时，此标识符可以是以下其中一项：

  • 用户的数字标识符
  • 用户的电子邮件地址
  • 字符串字面量 "me"，表示请求用户

查询参数

参数
capability

enum (Capability)

必需。应为此用户检查的功能。例如，如需检查用户是否可以创建插件附件，请将此值设置为 CREATE_ADD_ON_ATTACHMENT。
previewVersion

enum (PreviewVersion)

可选。API 的预览版本。

请求正文

请求正文必须为空。

响应正文

检查用户功能的响应。

如果成功，响应正文将包含结构如下的数据：

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

enum (Capability)

Google 课堂功能。
allowed

boolean

是否允许用户使用指定 capability。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅授权指南。

能力

用于表示该 capability 的枚举。

枚举
CAPABILITY_UNSPECIFIED 不受支持。
CREATE_ADD_ON_ATTACHMENT 能够创建和修改与 Developer Console 项目（用于发出请求的 OAuth 客户端 ID）关联的 AddOnAttachment。
UPDATE_GRADING_PERIOD_SETTINGS 能够修改评分周期设置。