Method: userProfiles.guardians.list

傳回要求使用者可查看的監護人清單，且僅限於符合要求的監護人。

如要列出要求使用者可查看監護人的任何學生的監護人資訊，請使用文字符號 - 做為學生 ID。

這個方法會傳回下列錯誤代碼：

  • PERMISSION_DENIED 如果已指定 studentId，且要求使用者無法查看該學生的監護人資訊；如果 "-" 已指定為 studentId，且使用者不是網域管理員；如果問題網域未啟用監護人功能；如果 invitedEmailAddress 篩選器是由非網域管理員的使用者設定；或其他存取錯誤。
  • INVALID_ARGUMENT：如果指定 studentId，但系統無法辨識格式 (不是電子郵件地址、API 中的 studentId，也非文字常值字串 me)。如果提供無效的 pageToken，系統也可能會傳回此值。
  • NOT_FOUND 指定 studentId 且系統可辨識其格式，但 Classroom 沒有該學生的記錄。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
studentId

string

根據監護人連結的學生篩選結果。識別碼可以是下列任一項：

  • 使用者的數字 ID
  • 使用者的電子郵件地址
  • 字串常值 "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

詳情請參閱授權指南。