Method: userProfiles.guardians.list

返回发出请求的用户可以查看的监护人列表（仅限与请求匹配的监护人）。

如需列出提出申请的用户可以查看的任何学生的监护人，请使用字面字符 - 作为学生 ID。

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

  • PERMISSION_DENIED（如果指定了 studentId，且提出请求的用户将无法查看该学生的监护人信息）、指定 "-" 为 studentId 且该用户不是网域管理员；如果未为相关网域启用监护人、invitedEmailAddress 过滤条件是由非网域管理员设置的，或者出现其他访问错误。
  • 如果指定了 studentId，但系统无法识别其格式（它不是电子邮件地址，也不是 API 中的 studentId 和字面量字符串 me），也可能返回 INVALID_ARGUMENT。如果提供的 pageToken 无效，也可能返回此错误。
  • 如果指定了 studentId，并且系统可以识别其格式，但 Google 课堂没有该学生的记录，则为 NOT_FOUND。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
studentId

string

按监护人关联的学生过滤结果。该标识符可以是以下项之一：

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

查询参数

参数
invitedEmailAddress

string

按原始邀请发送到的电子邮件地址对结果进行过滤，从而生成此监护人链接。只有网域管理员可以使用此过滤器。
pageToken

string

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

在其他方面，list 请求必须与生成此令牌的请求完全相同。
pageSize

integer

要返回的最大项数。零或未指定，表示服务器可以分配最大值。

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

请求正文

请求正文必须为空。

响应正文

列出监护人时的响应。

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

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

object (Guardian)

本页结果中符合请求中所指定条件的监护人。
nextPageToken

string

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

授权范围

需要以下 OAuth 范围之一：

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

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