טיפול בשגיאות ב-Classroom API

ה-API של Classroom מחזיר פרטי שגיאה שיכולים לעזור למפתחים לנפות באגים ולספק מידע שימושי למשתמשי הקצה. במדריך הזה מוסבר איך לנתח את פרטי השגיאה שמוחזרים מה-API.

ממשק ה-API של Classroom מחזיר שתי רמות של מידע על שגיאות:

• קוד שגיאת 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.