Method: userProfiles.guardians.delete

刪除監護人。

監護人不會再收到監護人通知，而且無法再透過此 API 存取監護人。

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

  • 如果提出要求的使用者沒有符合您提供的 studentId 條件，則要求的使用者無法管理 studentId 所識別學生的監護人、相關網域尚未啟用監護人或其他存取錯誤。PERMISSION_DENIED
  • 如果已指定 studentId，但系統無法辨識其格式，則為 INVALID_ARGUMENT (不是電子郵件地址，也不是 API 的 studentId)。
  • NOT_FOUND若提出要求的使用者可依要求修改監護人，studentId 但沒有取得該學生的Guardian記錄guardianId。

HTTP 要求

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

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

路徑參數

參數
studentId

string

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

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

string

Guardian 的 id 欄位。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會是空白的。

授權範圍

需要下列 OAuth 範圍：

  • https://www.googleapis.com/auth/classroom.guardianlinks.students

詳情請參閱授權指南。