L'API Classroom renvoie deux niveaux d'informations d'erreur:
- Codes et messages d'erreur HTTP dans l'en-tête
- Objet JSON dans le corps de la réponse avec des détails supplémentaires
Vous pouvez utiliser l'objet de réponse pour le débogage. Dans certains cas, la réponse peut contenir des détails d'erreur supplémentaires. Vous pouvez utiliser ces informations pour lever l'ambiguïté sur la cause de l'erreur et fournir des informations aux utilisateurs ou les inciter à prendre les mesures appropriées.
Structure des messages d'erreur
Le cas échéant, des détails supplémentaires sur l'erreur sont inclus dans le champ message de l'erreur au format @ suivi d'un code d'erreur.
Par exemple, si une requête échoue avec une erreur ClassroomApiDisabled, la réponse JSON se présentera comme suit:
{
"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"
}
}
Vous pouvez vérifier que le champ du message commence par "@ClassroomApiDisabled " et présenter une invite appropriée aux utilisateurs. Incluez un espace de fin lorsque vous recherchez un code d'erreur pour éviter toute correspondance avec d'autres valeurs commençant par la même chaîne.