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 " شروع شود و یک درخواست مناسب به کاربران ارائه دهید. برای جلوگیری از تطبیق مقادیر دیگر که با همان رشته شروع می شوند، یک فضای انتهایی را هنگام بررسی کد خطا وارد کنید.