Umgang mit Classroom API-Fehlern

Die Classroom API gibt Fehlerinformationen zurück, die Entwicklern bei der Fehlerbehebung helfen und Endnutzern hilfreiche, umsetzbare Informationen liefern können. In diesem Leitfaden wird erläutert, wie Sie Fehlerinformationen aus der API parsen.

Die Classroom API gibt zwei Fehlerebenen zurück:

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

Struktur von Fehlermeldungen

Die im Antworttext zurückgegebenen Fehler enthalten die folgenden Felder:

  • code: Der numerische HTTP-Fehlercode. Beispiel: 403.
  • message: Zusätzliche Details zum Fehler. Falls verfügbar, werden 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, würde die Antwort so aussehen:

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

Anhand des Antworttexts können Sie die Ursache des Fehlers beheben und Nutzern hilfreiche Informationen zur Verfügung stellen. Fügen Sie bei der Suche nach einer bestimmten Fehlermeldung einen abschließenden Leerraum ein, um Übereinstimmungen mit anderen Werten zu vermeiden, die mit demselben String beginnen. Im angegebenen Fehlerbeispiel können Sie prüfen, ob das Nachrichtenfeld mit "@ClassroomApiDisabled " beginnt, um Nutzern entsprechende Informationen zu präsentieren.

Auf den Seiten zu Zugriffsfehlern, Anfragefehlern und Add-on-Fehlern finden Sie Informationen zu einigen Fehlern, die von der Classroom API zurückgegeben werden können.

Weiter
Fehlerbehebung