傳回提出要求的使用者可檢視的監護人清單,僅限符合要求的使用者查看。
若要列出經要求使用者檢視監護人之學生的監護人,請使用學生 ID 常值字元 -
。
這個方法會傳回下列錯誤代碼:
- 如果已指定
studentId
,且提出要求的使用者不得查看該學生的監護人資訊,則無法將"-"
指定為studentId
、使用者並非網域管理員、如未為相關網域啟用監護人、由非網域管理員的使用者設定invitedEmailAddress
篩選器,或是設定其他存取錯誤。PERMISSION_DENIED
- 如果指定
studentId
,但系統無法辨識其格式 (不是電子郵件地址,或是 API 的studentId
,或是文字字串me
),則為INVALID_ARGUMENT
。此外,如果提供無效的pageToken
,也可能會傳回。 - 如果已指定
studentId
,且系統可辨識其格式,則為NOT_FOUND
,但 Classroom 沒有該學生的記錄。
HTTP 要求
GET https://classroom.googleapis.com/v1/userProfiles/{studentId}/guardians
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
studentId |
依監護人所連結的學生篩選結果。ID 可以是下列其中一項:
|
查詢參數
參數 | |
---|---|
invitedEmailAddress |
根據原始邀請的收件者電子郵件地址篩選結果,系統隨即會顯示這個監護人連結。這個篩選器僅供網域管理員使用。 |
pageToken |
從先前的
|
pageSize |
要傳回的項目數上限。0 或未指定時,表示伺服器可能會指派上限。 伺服器傳回的結果數量可能會少於指定數量。 |
要求主體
要求主體必須為空白。
回應主體
在列出監護人時回覆。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"guardians": [
{
object ( |
欄位 | |
---|---|
guardians[] |
本頁列出符合要求所指定條件的監護人。 |
nextPageToken |
用於識別下一頁結果的權杖。如果留空,系統就不會顯示進一步結果。 |
授權範圍
需要下列其中一種 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
詳情請參閱授權指南。