您的用户是通过 Google Meet 使用 Google 课堂吗?请查看 Apps 脚本快速入门 - 了解如何在 Google Meet 课程中查看学生出席情况

Method: userProfiles.guardianInvitations.patch

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。

修改监护人邀请。

目前,唯一有效的修改是将 statePENDING 更改为 COMPLETE。这相当于撤回邀请。

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

  • PERMISSION_DENIED如果当前用户没有管理监护人的权限,或者没有为相关网域或其他监护人访问错误启用监护人,则会发生此情况。
  • 如果监护人链接未处于 PENDING 状态,请使用 FAILED_PRECONDITION
  • INVALID_ARGUMENT如果提供的学生 ID 的格式无法识别(不是电子邮件地址,或者来自此 API 的 userId)、传递的 GuardianInvitation statestate 并非 COMPLETE 或者 <br class="2-3"> 修改了其他字段。
  • 如果提供的学生 ID 是有效的学生 ID,但 Google 课堂没有该学生的记录,或者 id 字段未引用 Google 课堂已知的监护人邀请,请使用 NOT_FOUND

HTTP 请求

PATCH https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardianInvitations/{invitationId}

网址采用 gRPC 转码语法。

路径参数

参数
studentId

string

要修改的监护人邀请的学生 ID。

invitationId

string

要修改的 GuardianInvitationid 字段。

查询参数

参数
updateMask

string (FieldMask format)

用于标识要更新的课程字段的掩码。必须填写此字段才能进行更新。如果指定了无效字段,更新将会失败。以下字段均有效:

  • state

在查询参数中设置时,此字段应指定为

updateMask=<field1>,<field2>,...

这是由字段的完全限定名称组成的逗号分隔列表。示例:"user.displayName,photo"

请求正文

请求正文包含一个 GuardianInvitation 实例。

响应正文

如果成功,响应正文将包含一个 GuardianInvitation 实例。

授权范围

需要以下 OAuth 作用域:

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

有关详情,请参阅 OAuth 2.0 概览