โครงสร้างข้อผิดพลาดของ Google Classroom API

Classroom API จะแสดงข้อมูลข้อผิดพลาดที่ช่วยให้นักพัฒนาซอฟต์แวร์ แก้ไขข้อบกพร่องและให้ข้อมูลที่เป็นประโยชน์และนำไปดำเนินการได้แก่ผู้ใช้ปลายทาง คำแนะนำนี้อธิบายวิธีแยกวิเคราะห์ข้อมูลข้อผิดพลาดที่ API ส่งคืน

Classroom API จะแสดงข้อมูลข้อผิดพลาด 2 ระดับ ดังนี้

• รหัสข้อผิดพลาด 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 อาจแสดงในหน้าข้อผิดพลาดที่พบบ่อย