Classroom API 會傳回錯誤資訊,協助開發人員排解問題,並為使用者提供實用的資訊。本指南說明如何剖析從 API 傳回的錯誤資訊。
Classroom API 會傳回兩種錯誤資訊:
- 標頭中的 HTTP 錯誤代碼。
- 回應主體中的物件,其中包含其他詳細資料。
錯誤訊息結構
回應主體中傳回的錯誤包含下列欄位:
code
:數字 HTTP 錯誤代碼。例如403
。message
:錯誤的其他詳細資料。如有可用訊息,系統會在錯誤訊息前方加上@
和特定錯誤類型。例如:@ClassroomApiDisabled
status
:HTTP 要求狀態。例如,PERMISSION_DENIED
或NOT_FOUND
。
如果要求失敗並顯示 ClassroomApiDisabled
錯誤,回應會是:
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"status": "PERMISSION_DENIED"
}
}
您可以利用回應主體來協助偵錯錯誤原因,並為使用者提供實用資訊。檢查特定錯誤訊息時請加上結尾空格,以免比對以相同字串開頭的其他值。在提供的錯誤範例中,您可以檢查訊息欄位是否以 "@ClassroomApiDisabled "
開頭,以便向使用者顯示適當的資訊。
如要瞭解 Classroom API 可能傳回的部分錯誤,請參閱「存取錯誤」、「要求錯誤」和「外掛程式錯誤」頁面。