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

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