Los complementos de Google Classroom ya están en fase de disponibilidad general para desarrolladores. Consulta la
documentación sobre complementos para obtener más información.
Estructura de errores de la API de Google Classroom
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
La API de Classroom devuelve información de errores que puede ayudar a los desarrolladores a depurar problemas y proporcionar información útil y práctica a los usuarios finales. En esta guía, se explica cómo analizar la información de errores que devuelve la API.
La API de Classroom devuelve dos niveles de información de error:
- Es el código de error HTTP en el encabezado.
- Es un objeto en el cuerpo de la respuesta con detalles adicionales.
Estructura del mensaje de error
Los errores que se muestran en el cuerpo de la respuesta incluyen los siguientes campos:
code: Es el código de error HTTP numérico. Por ejemplo, 403message: Son detalles adicionales sobre el error. Cuando está disponible, el mensaje de error se antepone con @ y un tipo de error específico. Por ejemplo, @ClassroomApiDisabled.status: Es el estado de la solicitud HTTP. Por ejemplo, PERMISSION_DENIED o NOT_FOUND.
Si una solicitud falló con un error ClassroomApiDisabled, la respuesta sería la siguiente:
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"status": "PERMISSION_DENIED"
}
}
Puedes usar el cuerpo de la respuesta para depurar la causa del error y proporcionar información útil a los usuarios. Incluye un espacio final cuando verifiques un mensaje de error específico para evitar que coincida con otros valores que comiencen con la misma cadena. En el ejemplo de error proporcionado, puedes verificar si el campo de mensaje comienza con "@ClassroomApiDisabled " para presentar información adecuada a los usuarios.
Consulta la página Errores comunes para obtener información sobre algunos errores que puede devolver la API de Classroom.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-08-29 (UTC)
[null,null,["Última actualización: 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."]]
