API Classroom возвращает информацию об ошибках, которая может помочь разработчикам отлаживать проблемы и предоставлять полезную, практическую информацию конечным пользователям. В этом руководстве объясняется, как анализировать информацию об ошибках, возвращаемую API.
API Classroom возвращает два уровня информации об ошибках:
- Код ошибки HTTP в заголовке.
- Объект в теле ответа с дополнительными сведениями.
Структура сообщения об ошибке
Ошибки, возвращаемые в теле ответа, включают следующие поля:
-
code: Числовой код ошибки HTTP. Например,403. -
message: Дополнительные сведения об ошибке. Если доступно, сообщение об ошибке начинается с@и определенного типа ошибки. Например,@ClassroomApiDisabled. -
status: Статус HTTP-запроса. Например,PERMISSION_DENIEDилиNOT_FOUND.
Если запрос завершился ошибкой ClassroomApiDisabled , ответ будет следующим:
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"status": "PERMISSION_DENIED"
}
}
Вы можете использовать тело ответа, чтобы помочь вам отладить причину ошибки и предоставить полезную информацию пользователям. Включите конечный пробел при проверке определенного сообщения об ошибке, чтобы избежать сопоставления других значений, начинающихся с той же строки. В приведенном примере ошибки вы можете проверить, начинается ли поле сообщения с "@ClassroomApiDisabled " , чтобы предоставить пользователям соответствующую информацию.
Информацию о некоторых ошибках, которые может возвращать API Classroom, можно найти на странице «Распространенные ошибки» .