Codes d’erreur et réponses

​

Structure de réponse typique

Les réponses réussies sont indiquées par un code HTTP de la série 200 et une charge utile JSON contenant le(s) objet(s) demandé(s), créé(s), modifié(s) ou supprimé(s), ainsi qu’une indication de la manière dont le serveur a interprété votre requête.

Si vous avez émis une requête avec succès, votre réponse comportera un nœud request qui renvoie votre requête.

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

{
  /* les données de votre réponse... */,
  "request": {
    "params": {
      "account_id": "abcdefg",
      "with_deleted": "true"
    }
  }
}

Le champ data dans les réponses JSON contient les objets spécifiques associés à la ressource exploitée. Le nœud data est un tableau JSON lorsque la réponse peut comporter un ou plusieurs résultats. Il est renvoyé sous forme de hash JSON lorsqu’un seul résultat est possible. Dans de rares cas, vous pouvez voir une réponse qui inclurait normalement une collection remplacée par un hashmap. Dans ce cas, considérez que le hashmap unique est un objet du même type que celui indiqué dans le champ type.

​

Structure de la réponse d’erreur

Les réponses d’erreur sont renvoyées avec un code HTTP hors de la série 200. En général, une réponse JSON est jointe, mais certaines erreurs renvoient des corps de réponse d’un autre type. Dans les situations où la structure de la réponse ne peut pas être analysée, considérez que la signification fondamentale du code HTTP prévaut. Par exemple, vous pouvez occasionnellement voir un code HTTP 404 accompagné d’une réponse HTML. Dans ce cas, il est raisonnable de supposer que le contenu est introuvable (HTTP 404 signifie « Not Found »).

Les réponses d’erreur typiques suivent une structure similaire à celle des réponses réussies. La nature de l’erreur est communiquée dans un nœud errors de la réponse. Le nœud errors/code indique un code d’erreur constant en CAPS_CASE que vous pouvez traiter de manière programmatique pour prendre des décisions de résolution. Le nœud errors/message indique une description (généralement) lisible par un humain de l’erreur, en anglais. Des fields supplémentaires peuvent être joints pour fournir des détails plus précis concernant l’erreur.

{
  "errors": [
    {
      "parameter": "start_time",
      "details": "date invalide",
      "code": "INVALID_PARAMETER",
      "value": "",
      "message": "Heure attendue, reçu \"\" pour start_time"
    }
  ],
  "request": {
    "params": {
      "account_id": "hkk5"
    }
  }
}

Dans l’exemple ci-dessus, une requête vers un endpoint d’analytique a été effectuée avec une valeur non valide pour le paramètre start_time. Le champ errors/code pour les requêtes comportant des paramètres non valides est INVALID_PARAMETER.

Code HTTP	Code d’erreur
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