गड़बड़ी के जवाब

गड़बड़ी के स्टैंडर्ड रिस्पॉन्स

Core Reporting API के अनुरोध स्वीकार होने पर, एपीआई 200 स्टेटस कोड दिखाता है. अगर किसी अनुरोध में कोई गड़बड़ी होती है, तो एपीआई अनुरोध में एचटीटीपी स्थिति कोड, स्थिति, और गड़बड़ी के टाइप के आधार पर उसकी वजह दिखाता है. इसके अलावा, जवाब के मुख्य हिस्से में, गड़बड़ी की वजह का पूरा ब्यौरा भी शामिल होता है. यहां गड़बड़ी के रिस्पॉन्स का एक उदाहरण दिया गया है:

{
 "error": {
  "errors": [
   {
    "domain": "global",
    "reason": "invalidParameter",
    "message": "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]",
    "locationType": "parameter",
    "location": "max-results"
   }
  ],
  "code": 400,
  "message": "Invalid value '-1' for max-results. Value must be within the range: [1, 1000]"
 }
}

ध्यान दें: ब्यौरा किसी भी समय बदला जा सकता है. इसलिए, ऐप्लिकेशन, जानकारी के असल टेक्स्ट पर निर्भर नहीं होना चाहिए.

गड़बड़ी की जानकारी देने वाली टेबल

कोड	वजह	जानकारी	सुझाई गई कार्रवाई
400	invalidParameter	इससे पता चलता है कि अनुरोध के पैरामीटर की वैल्यू अमान्य है. गड़बड़ी के जवाब में मौजूद locationType और location फ़ील्ड, अमान्य वैल्यू की जानकारी देते हैं.	समस्या को ठीक किए बिना फिर से कोशिश न करें. आपको गड़बड़ी के रिस्पॉन्स में बताए गए पैरामीटर के लिए एक मान्य वैल्यू देनी होगी.
400	badRequest	इससे पता चलता है कि क्वेरी अमान्य थी. उदाहरण के लिए, पैरंट आईडी मौजूद नहीं है या अनुरोध किए गए डाइमेंशन या मेट्रिक का कॉम्बिनेशन मान्य नहीं है.	समस्या को ठीक किए बिना फिर से कोशिश न करें. एपीआई क्वेरी काम करे, इसके लिए आपको उसमें बदलाव करने होंगे.
401	invalidCredentials	इससे पता चलता है कि पुष्टि करने वाला टोकन अमान्य है या उसकी समयसीमा खत्म हो चुकी है.	समस्या को ठीक किए बिना फिर से कोशिश न करें. आपको नया पुष्टि टोकन लेना होगा.
403	insufficientPermissions	इससे पता चलता है कि उपयोगकर्ता के पास क्वेरी में बताई गई इकाई के लिए ज़रूरी अनुमतियां नहीं हैं.	समस्या को ठीक किए बिना फिर से कोशिश न करें. इस इकाई पर कार्रवाई करने के लिए, आपके पास ज़रूरी अनुमतियां होनी चाहिए.
403	dailyLimitExceeded	इससे पता चलता है कि उपयोगकर्ता ने रोज़ की तय सीमा (हर प्रोजेक्ट या हर व्यू (प्रोफ़ाइल) के हिसाब से) पार कर ली है.	समस्या को ठीक किए बिना फिर से कोशिश न करें. आप अपने हर दिन के कोटे का इस्तेमाल कर चुके हैं. एपीआई की सीमाएं और कोटा देखें.
403	userRateLimitExceeded	इससे पता चलता है कि हर उपयोगकर्ता के लिए, 100 सेकंड के हिसाब से क्वेरी की सीमा पार हो गई है. Google API कंसोल में, हर उपयोगकर्ता के लिए 100 क्वेरी प्रति 100 सेकंड सेट की जाती हैं. Google API कंसोल में इस सीमा को ज़्यादा से ज़्यादा 1,000 तक बढ़ाया जा सकता है.	एक्सपोनेन्शियल बैक-ऑफ़ का इस्तेमाल करके फिर से कोशिश करें. आपको अनुरोध भेजने की दर धीमी करनी होगी.
403	rateLimitExceeded	इससे पता चलता है कि प्रोजेक्ट में हर 100 सेकंड के लिए क्वेरी की दर, तय सीमा को पार कर गई है.	एक्सपोनेन्शियल बैक-ऑफ़ का इस्तेमाल करके फिर से कोशिश करें. आपको अनुरोध भेजने की दर धीमी करनी होगी.
403	quotaExceeded	इससे पता चलता है कि Core Reporting API में, हर व्यू (प्रोफ़ाइल) के लिए एक साथ 10 अनुरोध पूरे हो चुके हैं.	एक्सपोनेन्शियल बैक-ऑफ़ का इस्तेमाल करके फिर से कोशिश करें. इस व्यू (प्रोफ़ाइल) के लिए, पहले से जारी कम से कम एक अनुरोध के पूरा होने तक इंतज़ार करना होगा.
500	internalServerError	सर्वर में ऐसी गड़बड़ी हुई जिसकी उम्मीद नहीं थी.	इस क्वेरी को एक से ज़्यादा बार फिर से न करें.
503	backendError	सर्वर ने कोई गड़बड़ी दिखाई.	इस क्वेरी को एक से ज़्यादा बार फिर से न करें.

500 या 503 रिस्पॉन्स मैनेज करना

ज़्यादा लोड होने के दौरान या ज़्यादा जटिल अनुरोधों के लिए 500 या 503 गड़बड़ी हो सकती है. बड़े अनुरोधों के लिए कम समयावधि के डेटा का अनुरोध करें. साथ ही, एक्सपोनेन्शियल बैकऑफ़ लागू करें. इन गड़बड़ियों की फ़्रीक्वेंसी, व्यू (प्रोफ़ाइल) और उस व्यू से जुड़े रिपोर्टिंग डेटा की संख्या पर निर्भर कर सकती है; कोई क्वेरी जिसकी वजह से एक व्यू (प्रोफ़ाइल) में 500 या 503 गड़बड़ी होती है, ज़रूरी नहीं है कि उसी क्वेरी के लिए किसी दूसरे व्यू (प्रोफ़ाइल) से गड़बड़ी हो.

एक्स्पोनेंशियल बैकऑफ़ लागू करना

एक्सपोनेन्शियल बैकऑफ़, एक ऐसी प्रोसेस है जिसमें क्लाइंट समय-समय पर, पूरे न हो पाने वाले अनुरोध को फिर से प्रोसेस करने की कोशिश करता है. यह नेटवर्क ऐप्लिकेशन के लिए, गड़बड़ियों को ठीक करने की एक मानक रणनीति है. Core Reporting API को इस उम्मीद के साथ डिज़ाइन किया गया है कि जो क्लाइंट पूरे न हो पाने वाले अनुरोधों की फिर से कोशिश करने का विकल्प चुनते हैं वे एक्सपोनेन्शियल बैकऑफ़ का इस्तेमाल करके ऐसा करते हैं. एक्सपोनेंशियल बैकऑफ़ "ज़रूरी" होने के अलावा, बैंडविथ के इस्तेमाल की क्षमता को बढ़ाता है. इसका जवाब देने के लिए ज़रूरी अनुरोधों की संख्या कम होती है. साथ ही, एक साथ कई एनवायरमेंट में अनुरोधों की संख्या भी बढ़ती है.

सिंपल एक्स्पोनेंशियल बैकऑफ़ लागू करने का तरीका यहां दिया गया है.

1. एपीआई से अनुरोध करें
2. गड़बड़ी का ऐसा रिस्पॉन्स मिलता है जिसमें फिर से कोशिश करने लायक गड़बड़ी का कोड होता है
3. 1 सेकंड + random_number_milliseconds सेकंड इंतज़ार करें
4. फिर से अनुरोध करें
5. गड़बड़ी का ऐसा रिस्पॉन्स मिलता है जिसमें फिर से कोशिश करने लायक गड़बड़ी का कोड होता है
6. 2 सेकंड + random_number_milliseconds सेकंड इंतज़ार करें
7. फिर से अनुरोध करें
8. गड़बड़ी का ऐसा रिस्पॉन्स मिलता है जिसमें फिर से कोशिश करने लायक गड़बड़ी का कोड होता है
9. 4 सेकंड + random_number_milliseconds सेकंड इंतज़ार करें
10. फिर से अनुरोध करें
11. गड़बड़ी का ऐसा रिस्पॉन्स मिलता है जिसमें फिर से कोशिश करने लायक गड़बड़ी का कोड होता है
12. 8 सेकंड + random_number_milliseconds सेकंड इंतज़ार करें
13. फिर से अनुरोध करें
14. गड़बड़ी का ऐसा रिस्पॉन्स मिलता है जिसमें फिर से कोशिश करने लायक गड़बड़ी का कोड होता है
15. 16 सेकंड + random_number_milliseconds सेकंड इंतज़ार करें
16. फिर से अनुरोध करें
17. अगर आपको अब भी गड़बड़ी का मैसेज मिलता है, तो गड़बड़ी को रोकें और उसकी जानकारी लॉग करें.

ऊपर दिए गए फ़्लो में, random_number_milliseconds 1,000 से कम या उसके बराबर मिलीसेकंड की एक रैंडम संख्या है. कुछ एक साथ लागू करने के तरीकों में लॉक की कुछ गड़बड़ियों से बचने के लिए यह ज़रूरी है. हर इंतज़ार के बाद, random_number_milliseconds को फिर से तय करना होगा.

ध्यान दें: इंतज़ार का समय हमेशा (2 ^ n) + random_number_milliseconds होता है. यहां n, एक जैसा बढ़ने वाला पूर्णांक है, जिसे शुरुआत में 0 के तौर पर दिखाया जाता है. हर बार n की संख्या में 1 की बढ़ोतरी होती है. हर अनुरोध के लिए ऐसा होता है.

n होने पर एल्गोरिदम खत्म हो जाता है. यह सीमा सिर्फ़ क्लाइंट को फिर से कोशिश करने से रोकने के लिए बनी है. इस वजह से, किसी अनुरोध को "ठीक नहीं की जा सकने वाली गड़बड़ी" माने जाने से पहले, करीब 32 सेकंड की देरी हो जाती है.

यहां दिया गया Python कोड, makeRequest नाम के तरीके में होने वाली गड़बड़ियों को वापस पाने के लिए, ऊपर दिए गए फ़्लो को लागू करता है.

import random
import time
from apiclient.errors import HttpError

def makeRequestWithExponentialBackoff(analytics):
  """Wrapper to request Google Analytics data with exponential backoff.

  The makeRequest method accepts the analytics service object, makes API
  requests and returns the response. If any error occurs, the makeRequest
  method is retried using exponential backoff.

  Args:
    analytics: The analytics service object

  Returns:
    The API response from the makeRequest method.
  """
  for n in range(0, 5):
    try:
      return makeRequest(analytics)

    except HttpError, error:
      if error.resp.reason in ['userRateLimitExceeded', 'quotaExceeded',
                               'internalServerError', 'backendError']:
        time.sleep((2 ** n) + random.random())
      else:
        break

  print "There has been an error, the request never succeeded."