Estructura de errores de la API de Google Classroom

La API de Classroom muestra 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 error que muestra la API.

La API de Classroom muestra dos niveles de información de error:

• 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, 403
• message: 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 falla 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 al final cuando busques 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 presentarles a los usuarios la información adecuada.

Consulta la página Errores comunes para obtener información sobre algunos errores que puede mostrar la API de Classroom.