Method: userProfiles.guardianInvitations.create

创建监护人邀请，并向监护人发送电子邮件，请他们确认自己是学生的监护人。

监护人接受邀请后，其state会变为COMPLETED，并且会开始收到监护人通知。系统还会创建一个 Guardian 资源来表示活跃监护人。

请求对象必须设置 studentId 和 invitedEmailAddress 字段。如果未能设置这些字段，或者未能在请求中设置任何其他字段，都会导致错误。

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

  • PERMISSION_DENIED如果当前用户无权管理监护人、相关监护人已针对该学生拒绝了过多请求、相关网域未启用监护人或出现其他访问错误。
  • 如果学生或监护人已超出监护人链接限制，则为 RESOURCE_EXHAUSTED。
  • 如果监护人的电子邮件地址无效（例如，过长），或提供的学生 ID 的格式无法识别（它不是电子邮件地址，也不是此 API 中的 userId），则为 INVALID_ARGUMENT。如果设置了只读字段，或 state 字段设置为 PENDING 以外的值，系统也会返回此错误。
  • 如果提供的学生 ID 是有效的学生 ID，但 Google 课堂没有该学生的记录，请NOT_FOUND。
  • 如果学生和所提供的invitedEmailAddress已有待处理的监护人邀请，或者提供的invitedEmailAddress与此用户现有Guardian的 Google 账号匹配，则为 ALREADY_EXISTS。

HTTP 请求

POST https://classroom.googleapis.com/v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations

网址采用 gRPC 转码语法。

路径参数

参数
guardianInvitation.studentId

string

学生的 ID（标准格式）

请求正文

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

响应正文

如果成功，响应正文将包含一个新创建的 GuardianInvitation 实例。

授权范围

需要以下 OAuth 作用域：

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

有关详情，请参阅授权指南。