एपीआई से जुड़ी गड़बड़ियां मैनेज करना

Classroom API, दो लेवल की गड़बड़ी की जानकारी देता है:

• हेडर में मौजूद एचटीटीपी गड़बड़ी कोड और मैसेज
• जवाब के मुख्य हिस्से में अतिरिक्त जानकारी के साथ 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 " से होती है या नहीं और उपयोगकर्ताओं को सही प्रॉम्प्ट दिखाएं. किसी एरर कोड की जांच करते समय, उसके बाद स्पेस शामिल करें, ताकि एक ही स्ट्रिंग से शुरू होने वाली अन्य वैल्यू को मैच न किया जा सके.