Códigos de error y respuestas

​

Estructura típica de la respuesta

Las respuestas exitosas se indican con un código HTTP de la serie 200 y una carga útil basada en JSON que contiene el o los objetos solicitados, creados, modificados o eliminados, junto con una indicación de cómo el servidor ha interpretado tu solicitud.

Si realizas una solicitud exitosa, recibirás como parte de tu respuesta un nodo request que refleja tu solicitud.

Ejemplo: GET accounts/abcdefg/campaigns?with_deleted=true

{
  /* los datos de su respuesta... */,
  "request": {
    "params": {
      "account_id": "abcdefg",
      "with_deleted": "true"
    }
  }
}

El campo data en las respuestas JSON contendrá los objetos específicos asociados con el recurso al que se accede. El formato del nodo data será un array JSON cuando la respuesta pueda contener uno o más resultados. Se devolverá como un hash JSON cuando solo sea posible un resultado en la respuesta. En algunos casos poco frecuentes, puedes ver una respuesta que normalmente incluiría una colección, pero que en su lugar contiene un hashmap. En este caso, asume que el único hashmap es un objeto del mismo type que se especifica en el campo type.

​

Estructura de la respuesta de error

Las respuestas de error se devuelven con un código HTTP fuera de la serie 200. Normalmente se adjunta una respuesta JSON, pero algunos errores responderán con diferentes tipos de cuerpo de la respuesta. En aquellas circunstancias en las que no se pueda analizar la estructura de la respuesta, considera que el significado principal del código HTTP tiene prioridad. Por ejemplo, es posible que ocasionalmente veas un HTTP 404 junto con una respuesta HTML. En este caso, es seguro asumir que el contenido no se puede encontrar (HTTP 404 significa “Not Found”).

Las respuestas de error típicas siguen una estructura similar a las respuestas satisfactorias. La naturaleza del error se comunicará en un nodo errors de la respuesta. El nodo errors/code indicará un código de error constante en formato CAPS_CASE que puedes consumir de forma programática para tomar decisiones sobre cómo resolverlo. El nodo errors/message indicará una descripción (normalmente) legible para humanos del error en inglés. Se pueden adjuntar campos adicionales para indicar detalles más específicos sobre el error.

{
  "errors": [
    {
      "parameter": "start_time",
      "details": "fecha no válida",
      "code": "INVALID_PARAMETER",
      "value": "",
      "message": "Se esperaba tiempo, se obtuvo \"\" para start_time"
    }
  ],
  "request": {
    "params": {
      "account_id": "hkk5"
    }
  }
}

En el ejemplo anterior, se realizó una solicitud a un endpoint de analytics con un valor no válido para el parámetro start_time. El errors/code para las solicitudes con parámetros no válidos es INVALID_PARAMETER.

Código HTTP	Código de error
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