Method: userProfiles.guardianInvitations.create

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

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

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

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

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

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

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