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