Classroom API จะแสดงข้อมูลข้อผิดพลาด 2 ระดับดังนี้
- รหัสข้อผิดพลาดของ 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 " และแสดงข้อความแจ้งที่เหมาะสมแก่ผู้ใช้ได้ เว้นวรรคต่อท้ายเมื่อตรวจหารหัสข้อผิดพลาดเพื่อหลีกเลี่ยงการจับคู่ค่าอื่นๆ ที่ขึ้นต้นด้วยสตริงเดียวกัน