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 से मिलने वाली कुछ गड़बड़ियों के बारे में जानने के लिए, ऐक्सेस से जुड़ी गड़बड़ियां, अनुरोध से जुड़ी गड़बड़ियां, और ऐड-ऑन से जुड़ी गड़बड़ियां पेजों पर जाएं.