त्रुटि कोड और प्रतिक्रियाएँ

सामान्य प्रतिक्रिया संरचना

सफल प्रतिक्रियाओं को 200-श्रेणी के HTTP कोड और JSON-आधारित पेलोड से दर्शाया जाता है, जिसमें अनुरोधित, निर्मित, संशोधित या हटाई गई ऑब्जेक्ट(s) के साथ-साथ आपके अनुरोध के बारे में सर्वर की व्याख्या भी शामिल होती है।

यदि आपने कोई सफल अनुरोध भेजा होता, तो प्रतिक्रिया के हिस्से के रूप में आपको एक request नोड मिलता, जो आपके अनुरोध को उसी रूप में लौटाता है।

उदाहरण: GET accounts/abcdefg/campaigns?with_deleted=true

{
  /* आपके प्रतिक्रिया का डेटा... */,
  "request": {
    "params": {
      "account_id": "abcdefg",
      "with_deleted": "true"
    }
  }
}

JSON प्रतिक्रियाओं में data फ़ील्ड में उपयोग किए जा रहे संसाधन से जुड़े विशिष्ट ऑब्जेक्ट शामिल होंगे। जब प्रतिक्रिया में एक या अधिक परिणाम हो सकते हैं, तो data नोड का प्रारूप JSON array होगा। जब प्रतिक्रिया में केवल एक परिणाम संभव हो, तो इसे JSON hash के रूप में लौटाया जाएगा। कुछ दुर्लभ मामलों में, आपको ऐसी प्रतिक्रिया दिखाई दे सकती है जिसमें सामान्यतः किसी collection के बजाय hashmap शामिल हो। इस स्थिति में, मान लें कि वह एकल hashmap type फ़ील्ड में निर्दिष्ट उसी type का एक ऑब्जेक्ट है।

त्रुटि प्रतिक्रिया संरचना

त्रुटि प्रतिक्रियाएँ non-200-series HTTP कोड के साथ लौटाई जाती हैं। आमतौर पर इसके साथ एक JSON प्रतिक्रिया जुड़ी होती है, लेकिन कुछ त्रुटियों में अलग प्रकार का body भी मिल सकता है। ऐसी परिस्थितियों में, जहाँ प्रतिक्रिया संरचना को parse नहीं किया जा सकता, HTTP कोड के मूल अर्थ को प्राथमिकता दें। उदाहरण के लिए, कभी-कभी आपको HTML प्रतिक्रिया के साथ HTTP 404 दिखाई दे सकता है। इस स्थिति में, यह मान लेना सुरक्षित है कि सामग्री नहीं मिली (HTTP 404 का अर्थ है “Not Found”).

सामान्य त्रुटि प्रतिक्रियाएँ सफल प्रतिक्रियाओं जैसी ही संरचना का पालन करती हैं। त्रुटि का प्रकार प्रतिक्रिया के errors node में बताया जाता है। errors/code node एक CAPS_CASE constant error code दर्शाता है, जिसका उपयोग आप समाधान से संबंधित निर्णय प्रोग्राम के माध्यम से लेने के लिए कर सकते हैं। errors/message node त्रुटि का (आमतौर पर) अंग्रेज़ी में, मनुष्यों द्वारा पढ़ा जा सकने वाला विवरण दर्शाता है। त्रुटि के बारे में अधिक सूक्ष्म जानकारी देने के लिए अतिरिक्त फ़ील्ड्स भी जोड़े जा सकते हैं।

{
  "errors": [
    {
      "parameter": "start_time",
      "details": "invalid date",
      "code": "INVALID_PARAMETER",
      "value": "",
      "message": "Expected time, got \"\" for start_time"
    }
  ],
  "request": {
    "params": {
      "account_id": "hkk5"
    }
  }
}

ऊपर दिए गए उदाहरण में, analytics endpoint के लिए start_time पैरामीटर का अमान्य मान देकर एक अनुरोध किया गया था। अमान्य पैरामीटर वाले अनुरोधों के लिए errors/code INVALID_PARAMETER होता है।

HTTP कोड	त्रुटि कोड
403	ACCOUNT_LOCKED_OUT
404	ACCOUNT_MEDIA_NOT_FOUND
403	ACCOUNT_NOT_FOUND
403	ACTION_NOT_ALLOWED
404	APP_EVENT_PROVIDER_CONFIGURATION_NOT_FOUND
404	APP_EVENT_TAG_NOT_FOUND
404	BEHAVIOR_OR_BEHAVIOR_EXPANDED_NOT_FOUND
404	CAMPAIGN_NOT_FOUND
408	CANCELLED_REQUEST
404	CARD_NOT_FOUND
403	CURRENT_USER_SUSPENDED
400	DUPLICATE_TWEET
400	EXCLUSIVE_PARAMETERS
400	FEATURE_NOT_AVAILABLE
403	FUNDING_INSTRUMENT_ACCESS_NOT_ALLOWED
403	FUNDING_INSTRUMENT_EXCEEDS_AVAILABLE_CREDIT_LIMIT
404	FUNDING_INSTRUMENT_NOT_FOUND
403	GENERIC_TWEET_ERROR
400	ILLEGAL_CHARACTERS
400	INCLUSIVE_PARAMETERS
500	INTERNAL_ERROR
404	INVALID_APP_ID
404	INVALID_APP_STORE
400	INVALID_DENOMINATION
400	INVALID_FUNDING_INSTRUMENT
404	INVALID_IAB_CATEGORY
404	INVALID_ID_ILLEGAL_CHARACTERS
400	INVALID_IMAGE
400	INVALID_MEDIA
400	INVALID_MEDIA_ID
400	INVALID_PARAMETER
400	INVALID_PLACEMENT_TYPE
400	INVALID_TAILORED_AUDIENCE_TYPE
400	INVALID_TARGETING_TYPE
400	INVALID_TIME_WINDOW
400	INVALID_TV_SHOW_LOCATIONS
400	INVALID_TWEET
400	INVALID_USER
400	INVALID_USER_ID
423	LOCK_ACQUISITION_TIMEOUT
404	LINE_ITEM_APP_NOT_FOUND
404	LINE_ITEM_NOT_FOUND
404	MACT_APP_NOT_FOUND
403	MALWARE_STATUS
404	MEDIA_CREATIVE_NOT_FOUND
404	MEDIA_NOT_FOUND
405	METHOD_NOT_ALLOWED
400	MISSING_PARAMETER
404	NO_PROVIDER_AVAILABLE_FOR_THIS_CLIENT_APPLICATION
404	NOT_FOUND
404	PROMOTABLE_USER_NOT_FOUND
404	PROMOTED_ACCOUNT_NOT_FOUND
404	PROMOTED_TWEET_NOT_FOUND
403	READONLY_CLIENT_APPLICATION
400	REQUEST_TOO_COMPLEX
404	ROUTE_NOT_FOUND
503	SERVICE_UNAVAILABLE
503	OVER_CAPACITY
400	SPEND_EXCEEDS_BUDGET
404	TAILORED_AUDIENCE_CHANGE_FILE_NOT_FOUND
404	TAILORED_AUDIENCE_NOT_FOUND
404	TAILORED_AUDIENCE_OR_TAILORED_AUDIENCE_EXPANDED_NOT_FOUND
404	TARGETING_CRITERION_NOT_FOUND
400	TOO_MANY_CAMPAIGNS
400	TOO_MANY_LINE_ITEMS
429	TOO_MANY_REQUESTS
400	TV_SHOW_OUTSIDE_MARKET
400	TWEET_CANNOT_BE_BLANK
403	TWEET_IS_SPAM
404	TWEET_NOT_FOUND
429	TWEET_RATE_LIMIT_EXCEEDED
401	UNAUTHORIZED_ACCESS
403	UNAUTHORIZED_CLIENT_APPLICATION
400	UNKNOWN_CARD_TYPE
400	UNKNOWN_CRITERIA_TYPE
403	USER_NOT_FOUND
404	WEB_EVENT_TAG_NOT_FOUND