L'API Classroom restituisce informazioni sugli errori che possono aiutare gli sviluppatori a eseguire il debug dei problemi e a fornire agli utenti finali informazioni utili e fruibili. Questa guida spiega come analizzare le informazioni sugli errori restituite dall'API.
L'API Classroom restituisce due livelli di informazioni sugli errori:
- Codice di errore HTTP nell'intestazione.
- Un oggetto nel corpo della risposta con ulteriori dettagli.
Struttura del messaggio di errore
Gli errori restituiti nel corpo della risposta includono i seguenti campi:
code: il codice di errore HTTP numerico. Ad esempio,403.message: dettagli aggiuntivi sull'errore. Se disponibile, al messaggio di errore viene anteposto@e un tipo di errore specifico. Ad esempio,@ClassroomApiDisabled.status: lo stato della richiesta HTTP. Ad esempio,PERMISSION_DENIEDoNOT_FOUND.
Se una richiesta non va a buon fine con un errore ClassroomApiDisabled, la risposta sarà:
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"status": "PERMISSION_DENIED"
}
}
Puoi utilizzare il corpo della risposta per aiutarti a eseguire il debug della causa dell'errore e fornire informazioni utili agli utenti. Includi uno spazio finale quando controlli
la presenza di un messaggio di errore specifico per evitare la corrispondenza di altri valori che iniziano con
la stessa stringa. Nell'esempio di errore fornito, puoi verificare se il campo messaggio inizia con "@ClassroomApiDisabled " per presentare informazioni appropriate agli utenti.
Fai riferimento alle pagine relative agli errori di accesso, agli errori di richiesta e agli errori dei componenti aggiuntivi per informazioni su alcuni errori che possono essere restituiti dall'API Classroom.