Method: userProfiles.guardians.list

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

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

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

  • 如果指定了 studentId,并且提出申请的用户被指定为 studentId 且该用户不是网域管理员,则如果未为相关网域启用监护人、invitedEmailAddress 过滤条件是由非网域管理员设置的,或者存在其他访问错误,则不允许提出请求的用户提供该学生的监护人信息。PERMISSION_DENIED"-"
  • 如果指定了 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

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

否则,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

有关详情,请参阅授权指南