Method: userProfiles.guardians.list

傳回允許提出要求的使用者查看的監護人清單，僅限符合要求的使用者檢視。

如要針對提出要求的使用者列出哪些學生的監護人，請使用學生 ID 的文字字元 -。

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

  • 如果指定 studentId 值，則 PERMISSION_DENIED，且如果將 "-" 指定為 studentId，且使用者不是網域管理員、如果相關網域未啟用監護人、問題所屬網域未啟用監護人、不是網域管理員設定的使用者設定，或者發生其他存取錯誤，則要求的使用者無權查看該學生的監護人資訊。invitedEmailAddress
  • 如果指定 studentId，但系統無法辨識其格式 (不是電子郵件地址、API 的 studentId，或常值字串 me)，則為 INVALID_ARGUMENT。如果提供無效的 pageToken，也可能傳回這個引數。
  • 如果已指定 studentId，且系統可辨識其格式，但 Classroom 沒有該學生的記錄，則為NOT_FOUND。

HTTP 要求

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

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

路徑參數

參數
studentId

string

依監護人所連結的學生篩選結果。ID 可以是下列其中一項：

  • 使用者的數字 ID
  • 使用者的電子郵件地址
  • 字串常值 "me"，表示提出要求的使用者
  • 字串常值 "-"，表示應針對要求使用者有權存取的所有學生傳回結果。

查詢參數

參數
invitedEmailAddress

string

按照原始邀請接收的電子郵件地址篩選結果，這會產生這個監護人連結。只有網域管理員才能使用這個篩選器。
pageToken

string

從前一個 list 呼叫傳回的 nextPageToken 值，表示應傳回後續結果頁面。

list 要求必須與導致這個權杖的要求相同，
pageSize

integer

傳回的項目數量上限。0 或未指定值表示伺服器可能會指派上限。

伺服器傳回的結果數量可能會少於指定數量。

要求主體

要求主體必須為空白。

回應主體

在列出監護人時回應。

如果成功，回應主體會含有以下結構的資料：

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

詳情請參閱授權指南。