Classroom API, geliştiricilerin sorunları gidermesine ve son kullanıcılara faydalı, uygulanabilir bilgiler sunmasına yardımcı olabilecek hata bilgileri döndürür. Bu kılavuzda, API'den döndürülen hata bilgilerinin nasıl ayrıştırılacağı açıklanmaktadır.
Classroom API iki düzeyde hata bilgisi döndürür:
- Başlıktaki HTTP hata kodu.
- Yanıt metninde ek ayrıntılar içeren bir nesne.
Hata mesajı yapısı
Yanıt metninde döndürülen hatalar aşağıdaki alanları içerir:
code: Sayısal HTTP hata kodu. Örneğin,403.message: Hatayla ilgili ek ayrıntılar. Mevcut olduğunda hata mesajına@ve belirli bir hata türü eklenir. Örneğin,@ClassroomApiDisabled.status: HTTP isteği durumu. Örneğin,PERMISSION_DENIEDveyaNOT_FOUND.
Bir istek ClassroomApiDisabled hatasıyla başarısız olursa yanıt şu şekilde olur:
{
"error": {
"code": 403,
"message": "@ClassroomApiDisabled The user is not permitted to access the Classroom API.",
"status": "PERMISSION_DENIED"
}
}
Hatanın nedenini gidermenize ve kullanıcılara faydalı bilgiler sağlamanıza yardımcı olması için yanıt gövdesini kullanabilirsiniz. Belirli bir hata mesajını kontrol ederken, aynı dizeyle başlayan diğer değerlerle eşleşmesini önlemek için sonuna bir boşluk ekleyin. Kullanıcılara uygun bilgileri sunmak için sağlanan hata örneğinde, mesaj alanının "@ClassroomApiDisabled " ile başlayıp başlamadığını kontrol edebilirsiniz.
Classroom API tarafından döndürülebilecek bazı hatalar hakkında bilgi edinmek için erişim hataları, istek hataları ve eklenti hataları sayfalarına bakın.