Fehlercodes und -antworten

​

Typische Antwortstruktur

Erfolgreiche Antworten werden durch einen HTTP-Statuscode aus der 200er‑Serie und eine JSON‑basierte Nutzlast gekennzeichnet, die die angeforderten, erstellten, geänderten oder gelöschten Objekte enthält, zusammen mit der Darstellung, wie der Server Ihre Anfrage interpretiert hat.

Bei einer erfolgreichen Anfrage erhalten Sie in der Antwort einen request-Knoten, der Ihre Anfrage widerspiegelt.

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

{
  /* die Daten Ihrer Antwort... */,
  "request": {
    "params": {
      "account_id": "abcdefg",
      "with_deleted": "true"
    }
  }
}

Das Feld data in JSON-Antworten enthält die spezifischen Objekte, die der verwendeten Ressource zugeordnet sind. Der data-Knoten hat das Format eines JSON-Arrays, wenn die Antwort ein oder mehrere Ergebnisse enthalten kann. Er wird als JSON hash zurückgegeben, wenn in der Antwort nur ein Ergebnis möglich ist. In einigen seltenen Fällen kann eine Antwort, die typischerweise eine Sammlung enthalten würde, stattdessen eine Hashmap enthalten. Gehen Sie in diesem Fall davon aus, dass die einzelne Hashmap ein Objekt desselben Typs ist, wie im Feld type angegeben.

​

Struktur von Fehlerantworten

Fehlerantworten werden mit einem HTTP-Code außerhalb der 200er-Reihe ausgeliefert. In der Regel ist eine JSON-Antwort enthalten, einige Fehler liefern jedoch andere Arten von Antwortkörpern. In Fällen, in denen sich die Antwortstruktur nicht parsen lässt, sollte die Kernbedeutung des HTTP-Codes Vorrang haben. Gelegentlich kann beispielsweise ein HTTP 404 zusammen mit einer HTML-Antwort auftreten. In diesem Fall ist es sicher anzunehmen, dass der Inhalt nicht gefunden werden kann (HTTP 404 bedeutet „Not Found“).

Typische Fehlerantworten folgen einer ähnlichen Struktur wie erfolgreiche Antworten. Die Art des Fehlers wird in einem errors-Knoten der Antwort mitgeteilt. Der Knoten errors/code gibt einen in CAPS_CASE geschriebenen, konstanten Fehlercode an, den Sie programmatisch auswerten können, um Entscheidungen zur Behebung zu treffen. Der Knoten errors/message enthält eine (in der Regel) für Menschen lesbare Beschreibung des Fehlers auf Englisch. Zusätzliche fields können angehängt werden, um feinere Details zum Fehler anzugeben.

{
  "errors": [
    {
      "parameter": "start_time",
      "details": "ungültiges Datum",
      "code": "INVALID_PARAMETER",
      "value": "",
      "message": "Zeitwert erwartet, „" für start_time erhalten"
    }
  ],
  "request": {
    "params": {
      "account_id": "hkk5"
    }
  }
}

Im obigen Beispiel wurde eine Anfrage an ein Analytics-endpoint mit einem ungültigen Wert für den Parameter start_time gestellt. Der errors/code für Anfragen mit ungültigen Parametern lautet INVALID_PARAMETER.

HTTP-Code	Fehlercode
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