ساختار خطای Google Classroom API

Classroom API اطلاعات خطا را برمی‌گرداند که می‌تواند به توسعه‌دهندگان کمک کند مشکلات را اشکال‌زدایی کنند و اطلاعات مفید و کاربردی را به کاربران نهایی ارائه دهند. این راهنما نحوه تجزیه اطلاعات خطای بازگشتی از API را توضیح می دهد.

Classroom API دو سطح از اطلاعات خطا را برمی گرداند:

  • کد خطای 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 برگردانده شود، به صفحه خطاهای رایج مراجعه کنید.

بعدی
پیام های خطای رایج