Classroom API iki düzeyde hata bilgisi döndürür:
- Başlıktaki HTTP hata kodları ve mesajları
- Yanıt gövdesinde, ek ayrıntılar içeren bir JSON nesnesi
Hata ayıklama için yanıt nesnesini kullanabilirsiniz. Bazı durumlarda yanıtta ek hata ayrıntıları içerebilir. Bu ayrıntıları, hatanın nedenini açıklığa kavuşturmak ve kullanıcılara bilgi vermek veya kullanıcıları uygun işlemleri yapmaya yönlendirmek için kullanabilirsiniz.
Hata Mesajı Yapısı
Varsa ek hata ayrıntıları, @ olarak biçimlendirilmiş hatanın message alanında ve ardından bir hata kodu eklenir.
Örneğin, istek ClassroomApiDisabled hatasıyla başarısız olduysa JSON yanıtı şu şekilde olur:
{
"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"
}
}
Mesaj alanının "@ClassroomApiDisabled " ile başlayıp başlamadığını kontrol edebilir ve kullanıcılara uygun bir istem gösterebilirsiniz. Aynı dizeyle başlayan diğer değerlerin eşleşmesini önlemek için hata kodu olup olmadığını kontrol ederken sonuna bir boşluk ekleyin.