处理 Classroom API 错误

Classroom API 会返回错误信息，这些信息可帮助开发者调试问题，并为最终用户提供实用且切实可行的相关信息。本指南介绍了如何解析 API 返回的错误信息。

Classroom 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 " 开头，以向用户显示适当的信息。

如需了解 Google 课堂 API 可能会返回的某些错误，请参阅访问权限错误、请求错误和插件错误页面。