Method: userProfiles.guardianInvitations.list

返回请求用户有权查看的监护人邀请列表，并按所提供的参数进行过滤。

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

  • PERMISSION_DENIED（如果指定了 studentId，并且请求的用户不被允许查看该学生的监护人邀请；如果指定了 "-" 作为 studentId，并且用户不是网域管理员；如果未为相关网域启用监护人；或者出现其他访问错误）。
  • 如果指定了 studentId，但无法识别其格式（它既不是电子邮件地址，也不是 API 中的 studentId，也不是字面量字符串 me），则返回 INVALID_ARGUMENT。如果提供的 pageToken 或 state 无效，也可能会返回此错误。
  • NOT_FOUND：如果指定了 studentId，并且其格式可识别，但 Google 课堂中没有该学生的记录。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
studentId

string

要返回其家长邀请的学生的 ID。标识符可以是以下各项之一：

  • 用户的数字标识符
  • 用户的电子邮件地址
  • 字符串字面量 "me"，表示请求用户
  • 字符串字面量 "-"，表示应针对请求用户有权查看家长邀请的所有学生返回结果。

查询参数

参数
invitedEmailAddress

string

如果指定了此参数，则仅返回具有指定 invitedEmailAddress 的结果。
states[]

enum (GuardianInvitationState)

如果指定了此参数，则系统仅返回具有指定 state 值的结果。否则，系统会返回 state 为 PENDING 的结果。
pageToken

string

从上一次 list 调用返回的 nextPageToken 值，表示应返回后续页面的结果。

否则，list 请求必须与生成此令牌的请求相同。
pageSize

integer

要返回的最大项数。零或未指定表示服务器可能会分配上限。

服务器返回的结果数量可能少于指定数量。

请求正文

请求正文必须为空。

响应正文

列出监护人邀请时的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "guardianInvitations": [
    {
      object (GuardianInvitation)
    }
  ],
  "nextPageToken": string
}
字段
guardianInvitations[]

object (GuardianInvitation)

与列表请求匹配的监护人邀请。
nextPageToken

string

标识要返回的下一页结果的令牌。如果为空，则表示没有更多结果。

授权范围

需要以下 OAuth 范围之一：

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

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