Estrutura de erro da API Google Classroom

A API Classroom retorna informações de erro que podem ajudar os desenvolvedores a depurar problemas e fornecer informações úteis e práticas aos usuários finais. Este guia explica como analisar as informações de erro retornadas pela API.

A API Classroom retorna dois níveis de informações de erro:

• Código de erro HTTP no cabeçalho.
• Um objeto no corpo da resposta com mais detalhes.

Estrutura da mensagem de erro

Os erros retornados no corpo da resposta incluem os seguintes campos:

• code: o código de erro HTTP numérico. Por exemplo, 403.
• message: mais detalhes sobre o erro. Quando disponível, a mensagem de erro é prefixada com @ e um tipo de erro específico. Por exemplo, @ClassroomApiDisabled.
• status: o status da solicitação HTTP. Por exemplo, PERMISSION_DENIED ou NOT_FOUND.

Se uma solicitação falhar com um erro ClassroomApiDisabled, a resposta será:

{
  "error": {
    "code": 403,
    "message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
    "status": "PERMISSION_DENIED"
  }
}

Você pode usar o corpo da resposta para ajudar a depurar a causa do erro e fornecer informações úteis aos usuários. Inclua um espaço à direita ao verificar uma mensagem de erro específica para evitar a correspondência com outros valores que começam com a mesma string. No exemplo de erro fornecido, você pode verificar se o campo de mensagem começa com "@ClassroomApiDisabled " para apresentar informações adequadas aos usuários.

Consulte a página Erros comuns para informações sobre alguns erros que podem ser retornados pela API Classroom.