Gestione degli errori API

L'API Classroom restituisce due livelli di informazioni sugli errori:

  • Codici di errore HTTP e messaggi nell'intestazione
  • Un oggetto JSON nel corpo della risposta con dettagli aggiuntivi

Puoi utilizzare l'oggetto risposta per il debug. In alcuni casi, la risposta può contenere dettagli aggiuntivi sull'errore. Puoi utilizzare questi dettagli per chiarire la causa dell'errore e fornire informazioni agli utenti o invitarli a intraprendere le azioni appropriate.

Struttura dei messaggi di errore

Se disponibili, vengono inclusi ulteriori dettagli sull'errore nel campo message dell'errore formattato come @ seguito da un codice di errore.

Ad esempio, se una richiesta non è andata a buon fine con un errore ClassroomApiDisabled, la risposta JSON sarebbe:

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

Puoi verificare che il campo del messaggio inizi con "@ClassroomApiDisabled " e presentare una richiesta appropriata agli utenti. Includi uno spazio finale quando controlli un codice di errore per evitare di trovare altri valori che iniziano con la stessa stringa.