Google Classroom API のエラー構造

Classroom API は、デベロッパーが問題をデバッグし、エンドユーザーに役立つ実用的な情報を提供するために役立つエラー情報を返します。このガイドでは、API から返されたエラー情報を解析する方法について説明します。

Classroom API は、次の 2 つのエラー情報を返します。

• ヘッダーの 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 " で始まるかどうかを確認して、ユーザーに適切な情報を提示できます。

Classroom API から返される可能性のあるエラーについては、一般的なエラーのページをご覧ください。