تعرض Classroom API معلومات عن الأخطاء التي يمكن أن تساعد المطوّرين في تصحيح أخطاء التطبيقات وتقديم معلومات مفيدة وقابلة للتنفيذ للمستخدمين النهائيين. يوضّح هذا الدليل كيفية تحليل معلومات الخطأ التي يتم عرضها من واجهة برمجة التطبيقات.
تعرض Classroom API مستويَين من معلومات الخطأ:
- رمز خطأ HTTP في العنوان
- عنصر في نص الاستجابة يتضمّن تفاصيل إضافية
بنية رسالة الخطأ
تشمل الأخطاء التي يتم عرضها في نص الاستجابة الحقول التالية:
code: رمز الخطأ الرقمي في HTTP مثلاً:403message: تفاصيل إضافية عن الخطأ عندما يكون ذلك متاحًا، يتمّ وضع@ونوع خطأ معيّن في بداية رسالة الخطأ. على سبيل المثال،@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.