Classroom API, गड़बड़ी की जानकारी देता है. इससे डेवलपर को समस्याओं को डीबग करने में मदद मिलती है. साथ ही, वे असली उपयोगकर्ताओं को काम की और कार्रवाई करने के लिए ज़रूरी जानकारी दे पाते हैं. इस गाइड में, एपीआई से मिली गड़बड़ी की जानकारी को पार्स करने का तरीका बताया गया है.
Classroom API, गड़बड़ी की जानकारी के दो लेवल दिखाता है:
- हेडर में एचटीटीपी गड़बड़ी का कोड.
- जवाब के मुख्य हिस्से में मौजूद एक ऑब्जेक्ट, जिसमें ज़्यादा जानकारी होती है.
गड़बड़ी के मैसेज का स्ट्रक्चर
जवाब के मुख्य भाग में दिखाई गई गड़बड़ियों में ये फ़ील्ड शामिल होते हैं:
code: एचटीटीपी गड़बड़ी का संख्यात्मक कोड. उदाहरण के लिए,403.message: गड़बड़ी के बारे में ज़्यादा जानकारी. उपलब्ध होने पर, गड़बड़ी के मैसेज से पहले@और गड़बड़ी का टाइप जोड़ा जाता है. उदाहरण के लिए,@ClassroomApiDisabled.status: एचटीटीपी अनुरोध का स्टेटस. उदाहरण के लिए,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 से मिलने वाली कुछ गड़बड़ियों के बारे में जानने के लिए, सामान्य गड़बड़ियां पेज देखें.