Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Interfejs Classroom API zwraca informacje o błędach, które mogą pomóc programistom w debugowaniu problemów i przekazywaniu użytkownikom przydatnych informacji. Ten przewodnik wyjaśnia, jak analizować informacje o błędach zwracane przez interfejs API.
Interfejs Classroom API zwraca 2 poziomy informacji o błędach:
Kod błędu HTTP w nagłówku.
Obiekt w treści odpowiedzi z dodatkowymi szczegółami.
Struktura komunikatu o błędzie
Błędy zwracane w treści odpowiedzi zawierają te pola:
code: numeryczny kod błędu HTTP. Na przykład: 403.
message: dodatkowe informacje o błędzie. Jeśli jest dostępny, komunikat o błędzie jest poprzedzony symbolem @ i konkretnym typem błędu. Na przykład:@ClassroomApiDisabled.
status: stan żądania HTTP. Na przykład PERMISSION_DENIED lub NOT_FOUND.
Jeśli żądanie zakończyło się błędem ClassroomApiDisabled, odpowiedź będzie wyglądać tak:
{"error":{"code":403,"message":"@ClassroomApiDisabled The user is not permitted to access the Classroom API.","status":"PERMISSION_DENIED"}}
Możesz użyć treści odpowiedzi, aby znaleźć przyczynę błędu i przekazać użytkownikom przydatne informacje. Podczas sprawdzania konkretnego komunikatu o błędzie dodaj na końcu spację, aby uniknąć dopasowania innych wartości, które zaczynają się od tego samego ciągu znaków. W podanym przykładzie błędu możesz sprawdzić, czy pole message
zaczyna się od znaku "@ClassroomApiDisabled ", aby wyświetlić użytkownikom odpowiednie informacje.
Informacje o niektórych błędach, które mogą być zwracane przez interfejs Classroom API, znajdziesz na stronie Typowe błędy.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 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."]]
