Cómo manejar errores de API

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

  • Códigos de error de HTTP y mensajes en el encabezado
  • Un objeto JSON en el cuerpo de la respuesta con detalles adicionales

Puedes usar el objeto de respuesta para la depuración. En algunos casos, la respuesta puede contener detalles adicionales del error. Puedes usar estos detalles para desambiguar la causa del error y proporcionar información a los usuarios o indicarles que tomen las medidas adecuadas.

Estructura del mensaje de error

Cuando esté disponible, se incluyen detalles adicionales del error en el campo message del error con formato @ seguido de un código de error.

Por ejemplo, si una solicitud falla con un error ClassroomApiDisabled, la respuesta JSON sería la siguiente:

{
  "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"
  }
}

Puedes comprobar que el campo del mensaje comience con "@ClassroomApiDisabled " y presentar un mensaje adecuado a los usuarios. Incluye un espacio final cuando busques un código de error para evitar hacer coincidir otros valores que comiencen con la misma string.