एपीआई का अनुरोध पूरा होने पर, एपीआई 200 OK स्टेटस कोड दिखाता है. साथ ही, जवाब के मुख्य हिस्से में अनुरोध किया गया डेटा दिखाता है. गड़बड़ी होने पर, एपीआई, Google APIs की ओर से तय किए गए कैननिकल गड़बड़ी कोड में से कोई एक कोड दिखाता है. यह कोड, एचटीटीपी स्टेटस कोड और गड़बड़ी की जानकारी देने वाले रिस्पॉन्स बॉडी से मैप किया जाता है. गड़बड़ी होने पर, डीबग करने में मदद पाने के लिए, JSON रिस्पॉन्स बॉडी में message और status फ़ील्ड की जांच करें.
गड़बड़ी का फ़ॉर्मैट
अगर किसी अनुरोध में गड़बड़ी होती है, तो एपीआई, सही एचटीटीपी स्टेटस कोड और JSON रिस्पॉन्स बॉडी दिखाता है. गड़बड़ी वाले जवाब में, error ऑब्जेक्ट शामिल होता है. इसका स्ट्रक्चर यहां दिया गया है:
{
"error": {
"code": 403,
"message": "User does not have sufficient permissions for this property.",
"status": "PERMISSION_DENIED"
}
}
error ऑब्जेक्ट में ये फ़ील्ड शामिल होते हैं:
| फ़ील्ड | ब्यौरा |
|---|---|
| code | एचटीटीपी स्टेटस कोड, जैसे कि 400, 401, 403, 429 या 500. |
| message | गड़बड़ी के बारे में कम शब्दों में जानकारी. |
| status | कैननिकल गड़बड़ी का कोड, जैसे कि INVALID_ARGUMENT, UNAUTHENTICATED, PERMISSION_DENIED, RESOURCE_EXHAUSTED या INTERNAL. |
आम तौर पर होने वाली गड़बड़ियां
यहां दी गई टेबल में, एपीआई से मिलने वाली सामान्य गड़बड़ियों की जानकारी दी गई है.
| एचटीटीपी स्टेटस कोड | कैननिकल कोड | कारण | ब्यौरा |
|---|---|---|---|
| 400 | INVALID_ARGUMENT |
गलत अनुरोध | अनुरोध गलत तरीके से किया गया है. ऐसा पैरामीटर के मौजूद न होने या अमान्य होने की वजह से हो सकता है. जैसे, तारीख की गलत सीमा या गलत फ़िल्टर. |
| 401 | UNAUTHENTICATED |
क्रेडेंशियल गलत हैं | अनुरोध में, टारगेट किए गए संसाधन के लिए पुष्टि करने के मान्य क्रेडेंशियल मौजूद नहीं हैं. ऐसा तब हो सकता है, जब OAuth 2.0 का ऐक्सेस टोकन मौजूद न हो, अमान्य हो या उसकी समयसीमा खत्म हो गई हो. मान्य टोकन पाने के लिए, OAuth 2.0 की मदद से पुष्टि करना में दिए गए निर्देशों का पालन करें. |
| 403 | PERMISSION_DENIED |
ज़रूरी अनुमतियां नहीं हैं | पुष्टि किए गए उपयोगकर्ता के पास, अनुरोध की गई Google Analytics प्रॉपर्टी का ऐक्सेस नहीं है. |
| 429 | RESOURCE_EXHAUSTED |
कोटा पार हो गया | एपीआई के लिए तय की गई सीमाएं पूरी हो गई हैं. इसलिए, अनुरोध को अस्वीकार कर दिया गया. ज़्यादा जानकारी के लिए, डेटा एपीआई की सीमाएं और कोटा देखें. ऐसा हो सकता है कि आपने हर प्रोजेक्ट या हर प्रॉपर्टी के हिसाब से तय की गई सीमाएं पार कर ली हों. |
| 500 | INTERNAL |
आंतरिक सर्वर त्रुटि | सर्वर में अचानक कोई गड़बड़ी हुई. आम तौर पर, यह समस्या कुछ समय के लिए होती है. हमारा सुझाव है कि अनुरोध को एक्स्पोनेंशियल बैकऑफ़ के साथ फिर से भेजा जाए. सर्वर की गड़बड़ी के कोटे से बचने के लिए, फिर से कोशिश करने की सीमाओं के साथ एक्स्पोनेंशियल बैकऑफ़ लागू करना ज़रूरी है. |
| 503 | UNAVAILABLE |
सेवा उपलब्ध नहीं है | यह सेवा कुछ समय के लिए उपलब्ध नहीं है. आम तौर पर, यह समस्या कुछ समय के लिए होती है. हमारा सुझाव है कि अनुरोध को एक्स्पोनेंशियल बैकऑफ़ के साथ फिर से भेजा जाए. सर्वर की गड़बड़ी के कोटे से बचने के लिए, फिर से कोशिश करने की सीमाओं के साथ एक्स्पोनेंशियल बैकऑफ़ लागू करना ज़रूरी है. |