Method: userProfiles.guardians.get

傳回特定監護人。

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

  • PERMISSION_DENIED 如果要求使用者無法看到與提供 studentId 相符的使用者、如果要求使用者無法查看 studentId 所識別學生的監護人資訊、如果問題網域未啟用監護人功能，或發生其他存取錯誤。
  • INVALID_ARGUMENT：如果指定了 studentId，但系統無法辨識格式 (不是電子郵件地址、不是 API 中的 studentId，也不是文字常值字串 me)。
  • NOT_FOUND：如果要求使用者有權查看要求的 studentId 監護人，但該學生沒有與提供的 guardianId 相符的 Guardian 記錄。

HTTP 要求

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

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

路徑參數

參數
studentId

string

要求監護人的學生。可以是下列其中一項：

  • 使用者的數字 ID
  • 使用者的電子郵件地址
  • 字串常值 "me"，表示要求使用者
guardianId

string

Guardian 中的 id 欄位。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會包含 Guardian 的執行例項。

授權範圍

需要下列其中一種 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

詳情請參閱授權指南。