Classroom API から返されるエラー情報には、次の 2 つのレベルがあります。
- ヘッダー内の 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 "
で始まっていることを確認し、適切なプロンプトをユーザーに表示できます。同じ文字列で始まる他の値を照合しないように、エラーコードを確認するときは末尾にスペースを入れます。