Структура ошибок API Google Classroom

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, можно найти на странице «Распространенные ошибки» .

Далее
Распространенные сообщения об ошибках