معالجة أخطاء واجهة برمجة التطبيقات

تعرض 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 " وتقديم الطلب المناسب للمستخدمين. قم بتضمين مسافة لاحقة عند التحقق من رمز الخطأ لتجنب مطابقة القيم الأخرى التي تبدأ بنفس السلسلة.