Method: userProfiles.guardians.list

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

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

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

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

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

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