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