Method: userProfiles.guardianInvitations.patch

修改监护人邀请。

目前，唯一有效的修改是将 state 从 PENDING 更改为 COMPLETE。这相当于撤消邀请。

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

  • PERMISSION_DENIED：如果当前用户无权管理家长，如果未为相关网域启用家长，或者存在其他访问权限错误。
  • 如果监护人关联状态不是 PENDING，则为 FAILED_PRECONDITION。
  • 如果无法识别所提供学生 ID 的格式（它既不是电子邮件地址，也不是此 API 中的 userId），或者传递的 GuardianInvitation 具有 COMPLETE 以外的 state，或者它修改了 state 以外的字段，则返回 INVALID_ARGUMENT。
  • 如果提供的学生 ID 是有效的学生 ID，但 Google 课堂中没有该学生的记录，或者 id 字段未提及 Google 课堂已知的监护人邀请，则返回 NOT_FOUND。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
studentId

string

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

string

要修改的 GuardianInvitation 的 id 字段。

查询参数

参数
updateMask

string (FieldMask format)

用于标识要更新的课程字段的掩码。若要进行更新，必须填写此字段。如果指定无效字段，更新将失败。以下字段有效：

  • state

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

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

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

请求正文

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

响应正文

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

授权范围

需要以下 OAuth 范围：

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

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