Mit Sammlungen den Überblick behalten
Sie können Inhalte basierend auf Ihren Einstellungen speichern und kategorisieren.
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.
[[["Leicht verständlich","easyToUnderstand","thumb-up"],["Mein Problem wurde gelöst","solvedMyProblem","thumb-up"],["Sonstiges","otherUp","thumb-up"]],[["Benötigte Informationen nicht gefunden","missingTheInformationINeed","thumb-down"],["Zu umständlich/zu viele Schritte","tooComplicatedTooManySteps","thumb-down"],["Nicht mehr aktuell","outOfDate","thumb-down"],["Problem mit der Übersetzung","translationIssue","thumb-down"],["Problem mit Beispielen/Code","samplesCodeIssue","thumb-down"],["Sonstiges","otherDown","thumb-down"]],["Zuletzt aktualisiert: 2025-08-29 (UTC)."],[],[],null,["# Google Classroom API error structure\n\nThe Classroom API returns error information that can help developers\ndebug issues and provide helpful, actionable information to end users. This\nguide explains how to parse error information returned from the API.\n\nThe Classroom API returns two levels of error information:\n\n- HTTP error code in the header.\n- An object in the response body with additional details.\n\nError message structure\n-----------------------\n\nErrors returned in the response body include the following fields:\n\n- `code`: The numerical HTTP error code. For example, `403`.\n- `message`: Additional details about the error. When available, the error message is prepended with `@` and a specific error type. For example, `@ClassroomApiDisabled`.\n- `status`: The HTTP request status. For example, `PERMISSION_DENIED` or `NOT_FOUND`.\n\nIf a request failed with a [`ClassroomApiDisabled`](/workspace/classroom/troubleshooting/common-errors#classroom-api-disabled) error, the response would\nbe: \n\n {\n \"error\": {\n \"code\": 403,\n \"message\": \"@ClassroomApiDisabled The user is not permitted to access the Classroom API.\",\n \"status\": \"PERMISSION_DENIED\"\n }\n }\n\nYou can use the response body to help you debug the cause of the error and\nprovide helpful information to users. Include a trailing space when checking\nfor a specific error message to avoid matching other values that start with\nthe same string. In the provided error example, you can check if the message\nfield begins with `\"@ClassroomApiDisabled \"` to present appropriate information\nto users.\n\nReference the [Common errors](/workspace/classroom/troubleshooting/common-errors) page for information on some errors that\ncan be returned by the Classroom API."]]
