API エラーの処理

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 " で始まっていることを確認し、適切なプロンプトをユーザーに表示します。エラーコードをチェックする際は、末尾にスペースを入れて、同じ文字列で始まる他の値と照合しないようにします。