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

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

• קודים והודעות של שגיאות 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 " ולהציג למשתמשים הנחיה מתאימה. כשמחפשים קוד שגיאה, כוללים רווח בסוף, כדי להימנע מהתאמה של ערכים אחרים שמתחילים באותה מחרוזת.