Обработка ошибок API

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 " и предоставить пользователям соответствующее приглашение. Включайте конечный пробел при проверке кода ошибки, чтобы избежать совпадения с другими значениями, начинающимися с той же строки.