Classroom API는 다음 두 가지 수준의 오류 정보를 반환합니다.
- HTTP 오류 코드 및 헤더의 메시지
- 추가 세부정보가 포함된 응답 본문의 JSON 객체
디버깅에 응답 객체를 사용할 수 있습니다. 경우에 따라 응답에 추가 오류 세부정보가 포함될 수 있습니다. 이러한 세부정보를 사용하여 오류의 원인을 명확히 하고 사용자에게 정보를 제공하거나 적절한 조치를 취하도록 지시할 수 있습니다.
오류 메시지 구조
가능한 경우 추가 오류 세부정보는 @ 뒤에 오류 코드가 오는 형식으로 오류의 message 필드에 포함됩니다.
예를 들어 요청이 ClassroomApiDisabled 오류로 인해 실패한 경우 JSON 응답은 다음과 같습니다.
{
"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"
}
}
메시지 필드가 "@ClassroomApiDisabled "로 시작하고 사용자에게 적절한 메시지를 표시하는지 확인할 수 있습니다. 오류 코드를 확인할 때 동일한 문자열로 시작하는 다른 값과 일치하지 않도록 후행 공백을 포함합니다.