Die Classroom API gibt zwei Ebenen mit Fehlerinformationen zurück:
- HTTP-Fehlercodes und -Meldungen im Header
- Ein JSON-Objekt im Antworttext mit zusätzlichen Details
Sie können das Antwortobjekt zur Fehlerbehebung verwenden. In einigen Fällen kann die Antwort zusätzliche Fehlerdetails enthalten. Anhand dieser Details können Sie die Ursache des Fehlers bestimmen und den Nutzern Informationen zur Verfügung stellen oder sie anweisen, entsprechende Maßnahmen zu ergreifen.
Struktur der Fehlermeldung
Sofern verfügbar, enthält das Feld message des Fehlers zusätzliche Fehlerdetails, die als @ gefolgt von einem Fehlercode formatiert sind.
Wenn beispielsweise eine Anfrage mit dem Fehler ClassroomApiDisabled fehlschlägt, würde die JSON-Antwort so lauten:
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"errors": [
{
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"domain": "global",
"reason": "forbidden"
}
],
"status": "PERMISSION_DENIED"
}
}
Sie können prüfen, ob das Nachrichtenfeld mit "@ClassroomApiDisabled " beginnt, und Nutzern eine entsprechende Aufforderung anzeigen. Fügen Sie bei der Suche nach Fehlercodes ein Leerzeichen am Ende hinzu, um zu verhindern, dass andere Werte abgeglichen werden, die mit demselben String beginnen.