Codici di errore e risposte

​

Struttura tipica della risposta

Le risposte positive sono indicate da un codice HTTP della serie 200 e da un payload in JSON che contiene gli oggetti richiesti, creati, modificati o eliminati, insieme a un’indicazione di come il server ha interpretato la tua richiesta.

In caso di richiesta eseguita correttamente, la risposta includerà un nodo request che restituisce il riepilogo della richiesta inviata.

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

{
  /* i dati della risposta... */,
  "request": {
    "params": {
      "account_id": "abcdefg",
      "with_deleted": "true"
    }
  }
}

Il campo data nelle risposte JSON conterrà gli oggetti specifici associati alla risorsa utilizzata. Il nodo data sarà un array JSON quando la risposta può contenere uno o più risultati. Verrà restituito come hash JSON quando nella risposta è possibile un solo risultato. In rari casi, potresti vedere una risposta che normalmente includerebbe una collezione sostituita da una hashmap. In tal caso, considera la singola hashmap come un oggetto dello stesso tipo indicato nel campo type.

​

Struttura della risposta di errore

Le risposte di errore vengono restituite con un codice HTTP non appartenente alla serie 200. Di solito è presente una risposta JSON, ma alcuni errori possono avere un body di tipo diverso. In queste circostanze, quando la struttura della risposta non può essere analizzata, considera prioritario il significato del codice HTTP. Ad esempio, potresti occasionalmente vedere un HTTP 404 insieme a una risposta HTML. In questo caso, è ragionevole presumere che il contenuto non sia stato trovato (HTTP 404 significa “Not Found”).

Le risposte di errore tipiche seguono una struttura simile a quella delle risposte con esito positivo. La natura dell’errore viene comunicata in un nodo errors della risposta. Il nodo errors/code indica un codice di errore costante in CAPS_CASE che puoi utilizzare a livello programmatico per prendere decisioni di gestione. Il nodo errors/message indica una descrizione (di solito) leggibile da esseri umani dell’errore, in inglese. Possono essere presenti campi aggiuntivi per fornire dettagli più granulari sull’errore.

{
  "errors": [
    {
      "parameter": "start_time",
      "details": "data non valida",
      "code": "INVALID_PARAMETER",
      "value": "",
      "message": "Previsto valore temporale, ricevuto \"\" per start_time"
    }
  ],
  "request": {
    "params": {
      "account_id": "hkk5"
    }
  }
}

Nell’esempio sopra, è stata inviata una richiesta a un endpoint di analytics con un valore non valido per il parametro start_time. Il valore di errors/code per le richieste con parametri non validi è INVALID_PARAMETER.

Codice HTTP	Codice errore
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