Interfejs Classroom API zwraca 2 poziomy informacji o błędach:
- Kody błędów HTTP i komunikaty w nagłówku
- Obiekt JSON w treści odpowiedzi z dodatkowymi informacjami
Obiektu odpowiedzi możesz użyć do debugowania. W niektórych przypadkach odpowiedź może zawierać dodatkowe szczegóły błędu. Dzięki tym informacjom możesz określić przyczynę błędu i przekazać informacje użytkownikom lub nakłonić ich do podjęcia odpowiednich działań.
Struktura komunikatów o błędach
Dodatkowe szczegóły błędu, jeśli są dostępne, są podane w polu message błędu w formacie @, po którym następuje kod błędu.
Jeśli na przykład żądanie nie zwróci się z powodu błędu ClassroomApiDisabled, odpowiedź JSON będzie wyglądać tak:
{
"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"
}
}
Możesz sprawdzić, czy pole wiadomości zaczyna się od "@ClassroomApiDisabled " i czy użytkownicy widzą odpowiedni komunikat. Podczas sprawdzania kodu błędu wstaw spację na końcu, aby uniknąć dopasowania innych wartości rozpoczynających się od tego samego ciągu.