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 से मिलने वाली कुछ गड़बड़ियों के बारे में जानने के लिए, आम गड़बड़ियां पेज देखें.