gws-classroom

classroom (v1)

先决条件： 阅读 ../gws-shared/SKILL.md 了解认证、全局标志和安全规则。如果缺失，请运行 gws generate-skills 创建它。

gws classroom <resource> <method> [flags]

API 资源

courses

• create — 创建课程。ownerId 中指定的用户是所创建课程的所有者，并作为教师添加。非管理员请求用户只能创建以自己为所有者的课程。域管理员可以创建其域内任何用户拥有的课程。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权创建课程或存在访问错误。* NOT_FOUND 如果主要教师不是有效用户。
• delete — 删除课程。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权删除请求的课程或存在访问错误。* NOT_FOUND 如果不存在具有请求 ID 的课程。
• get — 返回课程。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权访问请求的课程或存在访问错误。* NOT_FOUND 如果不存在具有请求 ID 的课程。
• getGradingPeriodSettings — 返回课程中的评分周期设置。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权访问请求课程中的评分周期设置或存在访问错误。* NOT_FOUND 如果请求的课程不存在。
• list — 返回请求用户有权查看的课程列表，仅限于与请求匹配的课程。返回的课程按创建时间排序，最近创建的排在前面。此方法返回以下错误代码：* PERMISSION_DENIED 访问错误。* INVALID_ARGUMENT 如果查询参数格式错误。* NOT_FOUND 如果查询参数中指定的任何用户不存在。
• patch — 更新课程中的一个或多个字段。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权修改请求的课程或存在访问错误。* NOT_FOUND 如果不存在具有请求 ID 的课程。* INVALID_ARGUMENT 如果更新掩码中指定了无效字段或未提供更新掩码。
• update — 更新课程。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权修改请求的课程或存在访问错误。* NOT_FOUND 如果不存在具有请求 ID 的课程。* FAILED_PRECONDITION 对于以下请求错误：* CourseNotModifiable * CourseTitleCannotContainUrl
• updateGradingPeriodSettings — 更新课程的评分周期设置。可以使用此方法添加、删除或修改单个评分周期。请求用户和课程所有者必须符合修改评分周期的资格。有关详细信息，请参阅许可要求。
• aliases — 对 'aliases' 资源的操作
• announcements — 对 'announcements' 资源的操作
• courseWork — 对 'courseWork' 资源的操作
• courseWorkMaterials — 对 'courseWorkMaterials' 资源的操作
• posts — 对 'posts' 资源的操作
• studentGroups — 对 'studentGroups' 资源的操作
• students — 对 'students' 资源的操作
• teachers — 对 'teachers' 资源的操作
• topics — 对 'topics' 资源的操作

invitations

• accept — 接受邀请，移除邀请并将被邀请用户添加到指定课程的教师或学生（视情况而定）。只有被邀请用户才能接受邀请。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权接受请求的邀请或存在访问错误。
• create — 创建邀请。一个用户和课程只能同时存在一个邀请。删除并重新创建邀请以进行更改。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权为此课程创建邀请或存在访问错误。* NOT_FOUND 如果课程或用户不存在。* FAILED_PRECONDITION：* 如果请求用户的帐户已禁用。
• delete — 删除邀请。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权删除请求的邀请或存在访问错误。* NOT_FOUND 如果不存在具有请求 ID 的邀请。
• get — 返回邀请。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权查看请求的邀请或存在访问错误。* NOT_FOUND 如果不存在具有请求 ID 的邀请。
• list — 返回请求用户有权查看的邀请列表，仅限于与列表请求匹配的邀请。注意： 必须至少提供 user_id 或 course_id 中的一个。两个字段都可以提供。此方法返回以下错误代码：* PERMISSION_DENIED 访问错误。

registrations

• create — 创建一个 Registration，使 Classroom 开始从提供的 feed 向 cloudPubSubTopic 中指定的目标发送通知。返回创建的 Registration。目前，这将与参数相同，但服务器分配的字段如 expiry_time 和 id 会被填充。请注意，为 expiry_time 或 id 字段指定的任何值都将被忽略。
• delete — 删除一个 Registration，使 Classroom 停止发送该 Registration 的通知。

userProfiles

• get — 返回用户个人资料。此方法返回以下错误代码：* PERMISSION_DENIED 如果请求用户无权访问此用户个人资料，或不存在具有请求 ID 的个人资料，或存在访问错误。
• guardianInvitations — 对 'guardianInvitations' 资源的操作
• guardians — 对 'guardians' 资源的操作

发现命令

在调用任何 API 方法之前，先检查它：

# 浏览资源和方法
gws classroom --help

# 检查方法的必需参数、类型和默认值
gws schema classroom.<resource>.<method>

使用 gws schema 输出来构建你的 --params 和 --json 标志。