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

API класса возвращает информацию об ошибках, которая может помочь разработчикам устранять проблемы и предоставлять конечным пользователям полезную и полезную информацию. В этом руководстве объясняется, как анализировать информацию об ошибках, возвращаемую API.

API Класса возвращает два уровня информации об ошибках:

• Код ошибки 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 класса.