Google Classroom API hata yapısı

Classroom API, geliştiricilerin sorunları ayıklamasına ve son kullanıcılara yararlı, uygulanabilir bilgiler sağlamasına yardımcı olabilecek hata bilgilerini 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 gövdesinde 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: Hata hakkında ek ayrıntılar. Kullanılabildiğinde hata mesajının başına @ ve belirli bir hata türü eklenir. Örneğin, @ClassroomApiDisabled.
• status: HTTP isteğinin durumu. Örneğin, PERMISSION_DENIED veya NOT_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"
  }
}

Yanıt gövdesini, hatanın nedenini ayıklamanıza ve kullanıcılara faydalı bilgiler sağlamanıza yardımcı olması için kullanabilirsiniz. Aynı dizeyle başlayan diğer değerlerle eşleşmeyi önlemek için belirli bir hata mesajını kontrol ederken sondaki boşluğu ekleyin. Sağlanan hata örneğinde, kullanıcılara uygun bilgileri sunmak için ileti alanının "@ClassroomApiDisabled " ile başlayıp başlamadığını kontrol edebilirsiniz.

Classroom API tarafından döndürülebilen bazı hatalar hakkında bilgi edinmek için Sık karşılaşılan hatalar sayfasına bakın.