处理 API 错误

Classroom 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 " 开头,并向用户显示适当的提示。在检查错误代码时请在尾部添加空格,以避免匹配以同一字符串开头的其他值。