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

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