Structure des erreurs de l'API Google Classroom
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
L'API Classroom renvoie des informations sur les erreurs qui peuvent aider les développeurs à résoudre les problèmes et à fournir des informations utiles et pratiques aux utilisateurs finaux. Ce guide explique comment analyser les informations sur les erreurs renvoyées par l'API.
L'API Classroom renvoie des informations sur les erreurs à deux niveaux :
- Code d'erreur HTTP dans l'en-tête.
- Objet dans le corps de la réponse contenant des informations supplémentaires.
Structure des messages d'erreur
Les erreurs renvoyées dans le corps de la réponse incluent les champs suivants :
code : code d'erreur HTTP numérique. Exemple :403message : informations supplémentaires sur l'erreur. Le cas échéant, le message d'erreur est précédé de @ et d'un type d'erreur spécifique. Exemple : @ClassroomApiDisabled.status : état de la requête HTTP. Par exemple, PERMISSION_DENIED ou NOT_FOUND.
Si une requête a échoué avec une erreur ClassroomApiDisabled, la réponse serait la suivante :
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"status": "PERMISSION_DENIED"
}
}
Vous pouvez utiliser le corps de la réponse pour vous aider à déboguer la cause de l'erreur et fournir des informations utiles aux utilisateurs. Incluez un espace à la fin lorsque vous recherchez un message d'erreur spécifique pour éviter de faire correspondre d'autres valeurs qui commencent par la même chaîne. Dans l'exemple d'erreur fourni, vous pouvez vérifier si le champ de message commence par "@ClassroomApiDisabled " pour présenter les informations appropriées aux utilisateurs.
Consultez la page Erreurs courantes pour en savoir plus sur certaines erreurs qui peuvent être renvoyées par l'API Classroom.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/29 (UTC).
[null,null,["Dernière mise à jour le 2025/08/29 (UTC)."],[],[],null,["# Google Classroom API error structure\n\nThe Classroom API returns error information that can help developers\ndebug issues and provide helpful, actionable information to end users. This\nguide explains how to parse error information returned from the API.\n\nThe Classroom API returns two levels of error information:\n\n- HTTP error code in the header.\n- An object in the response body with additional details.\n\nError message structure\n-----------------------\n\nErrors returned in the response body include the following fields:\n\n- `code`: The numerical HTTP error code. For example, `403`.\n- `message`: Additional details about the error. When available, the error message is prepended with `@` and a specific error type. For example, `@ClassroomApiDisabled`.\n- `status`: The HTTP request status. For example, `PERMISSION_DENIED` or `NOT_FOUND`.\n\nIf a request failed with a [`ClassroomApiDisabled`](/workspace/classroom/troubleshooting/common-errors#classroom-api-disabled) error, the response would\nbe: \n\n {\n \"error\": {\n \"code\": 403,\n \"message\": \"@ClassroomApiDisabled The user is not permitted to access the Classroom API.\",\n \"status\": \"PERMISSION_DENIED\"\n }\n }\n\nYou can use the response body to help you debug the cause of the error and\nprovide helpful information to users. Include a trailing space when checking\nfor a specific error message to avoid matching other values that start with\nthe same string. In the provided error example, you can check if the message\nfield begins with `\"@ClassroomApiDisabled \"` to present appropriate information\nto users.\n\nReference the [Common errors](/workspace/classroom/troubleshooting/common-errors) page for information on some errors that\ncan be returned by the Classroom API."]]
