處理 API 錯誤

Classroom API 會傳回兩種層級的錯誤資訊：

• 標頭中的 HTTP 錯誤代碼和訊息
• 回應主體中的 JSON 物件，內含其他詳細資料

您可以使用回應物件進行偵錯。在某些情況下，回應中可能會包含額外的錯誤詳細資料。您可以利用這些詳細資料釐清錯誤的原因，並提供資訊給使用者，或引導他們採取適當行動。

錯誤訊息結構

其他錯誤詳細資料會包含在錯誤的 message 欄位中，格式為 @，後面接著錯誤代碼。

舉例來說，如果要求失敗並出現 ClassroomApiDisabled 錯誤，JSON 回應會是：

{
  "error": {
    "code": 403,
      "message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
      "errors": [
        {
          "message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
          "domain": "global",
          "reason": "forbidden"
        }
      ],
      "status": "PERMISSION_DENIED"
  }
}

您可以檢查訊息欄位是否以 "@ClassroomApiDisabled " 開頭，並向使用者顯示適當的提示。檢查錯誤代碼時請在結尾加入空格，避免比對其他以相同字串開頭的值。