Fehlerstruktur der Google Classroom API

Die Classroom API gibt Fehlerinformationen zurück, die Entwicklern helfen können, Probleme zu beheben und Endnutzern hilfreiche, umsetzbare Informationen zu geben. In diesem Leitfaden wird erläutert, wie Sie von der API zurückgegebene Fehlerinformationen parsen.

Die Classroom API gibt zwei Arten von Fehlerinformationen zurück:

  • HTTP-Fehlercode im Header.
  • Ein Objekt im Antworttext mit zusätzlichen Details.

Struktur von Fehlermeldungen

Fehler, die im Antworttext zurückgegeben werden, enthalten die folgenden Felder:

  • code: Der numerische HTTP-Fehlercode. Beispiel: 403.
  • message: Zusätzliche Details zum Fehler. Wenn verfügbar, wird der Fehlermeldung @ und ein bestimmter Fehlertyp vorangestellt. Beispiel: @ClassroomApiDisabled.
  • status: Der HTTP-Anfragestatus. Beispiel: PERMISSION_DENIED oder NOT_FOUND.

Wenn eine Anfrage mit dem Fehler ClassroomApiDisabled fehlgeschlagen ist, sieht die Antwort so aus:

{
  "error": {
    "code": 403,
    "message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
    "status": "PERMISSION_DENIED"
  }
}

Mithilfe des Antworttexts können Sie die Ursache des Fehlers beheben und Nutzern hilfreiche Informationen zur Verfügung stellen. Fügen Sie ein nachgestelltes Leerzeichen ein, wenn Sie nach einer bestimmten Fehlermeldung suchen, um zu vermeiden, dass andere Werte gefunden werden, die mit demselben String beginnen. Im bereitgestellten Fehlerbeispiel können Sie prüfen, ob das Feld „message“ mit "@ClassroomApiDisabled " beginnt, um Nutzern die entsprechenden Informationen zu präsentieren.

Informationen zu einigen Fehlern, die von der Classroom API zurückgegeben werden können, finden Sie auf der Seite Häufige Fehler.

Weiter
Häufige Fehlermeldungen