API Lớp học trả về hai cấp độ thông tin lỗi:
- Mã lỗi HTTP và thông báo trong tiêu đề
- Đối tượng JSON trong nội dung phản hồi có thêm thông tin chi tiết
Bạn có thể sử dụng đối tượng phản hồi để gỡ lỗi. Trong một số trường hợp, phản hồi có thể chứa thêm thông tin chi tiết về lỗi. Bạn có thể sử dụng những thông tin chi tiết này để phân biệt nguyên nhân gây ra lỗi và cung cấp thông tin cho người dùng hoặc hướng dẫn họ thực hiện hành động phù hợp.
Cấu trúc thông báo lỗi
Nếu có, thông tin chi tiết bổ sung về lỗi sẽ được đưa vào trường message của lỗi có định dạng @ theo sau là mã lỗi.
Ví dụ: nếu một yêu cầu không thành công do gặp lỗi ClassroomApiDisabled, phản hồi JSON sẽ là:
{
"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"
}
}
Bạn có thể kiểm tra để đảm bảo trường thông báo bắt đầu bằng "@ClassroomApiDisabled " và hiển thị lời nhắc thích hợp cho người dùng. Thêm dấu cách ở cuối khi kiểm tra mã lỗi để tránh so khớp các giá trị khác bắt đầu bằng cùng một chuỗi.