Bu sayfada, isteklerin Google Classroom API'de işleyiş şekline dair genel bir bakış sunulmaktadır. Amacımız, kaynak odaklı tasarım veya Google Workspace API'leri hakkında bilgi sahibi olmayan okuyuculara yardımcı olmaktır.
Belirli kod örnekleri için ilgili API kılavuzlarına bakın (ör. Kurs oluşturma ve yönetme veya Öğrenci çalışması oluşturma ve yönetme).
Kaynak odaklı tasarım
API yapısı bölümünde belirtildiği gibi, Classroom API kaynak odaklı tasarım kalıplarını izler. Çoğu kaynağın, kaynak örneklerini oluşturma, okuma, güncelleme ve silme gibi standart işlemler için yöntemleri vardır.
Örneğin, API'yi kullanarak bir Classroom Course'i create(), patch(), get(), list() ve delete() oluşturabilirsiniz.
Oluştur
Course gibi yeni bir kaynak oluşturmak için ilgili kaynağın create() yöntemini çağırın.
Create() çağrıları her zaman giriş olarak ilgili kaynağın ilk ve kritik ayrıntılarını gerektirir. Örneğin, bir Course oluşturmak için Course kaynağındaki create() yöntemini çağırın ve istekte room gibi isteğe bağlı bilgilerle birlikte name ve description öğelerini belirtin.
Alt kaynaklar (bazen alt kaynaklar olarak da adlandırılır) için üst kaynağın tanımlayıcıları da gereklidir. Örneğin, bir Course içinde CourseWork oluştururken Course id, CourseWork'un hangi Course'a ait olduğunu belirlemek için gereklidir.
Create() yöntemleri, API çağrısı yanıtında yeni oluşturulan kaynağın bir örneğini döndürür. Döndürülen kaynakta genellikle id veya creationTime kaynağı gibi sunucu tarafından oluşturulan ek alanlar bulunur.
Yama
Mevcut kaynakları değiştirmek için ilgili kaynakta patch() yöntemini (bazen update() olarak da adlandırılır) çağırın. patch() yöntemi, create() ile neredeyse aynıdır ancak iki temel farkla: patch() yöntemini çağırırken şunları belirtmeniz gerekir:
- Değiştirilecek kaynağın
id. - Kaynakta hangi alanların güncelleneceğini belirlemek için
updateMaskadlı bir alan listesi. Varsayılan bir alan grubu olduğunda veya alanlar çıkarıldığında bu isteğe bağlıdır.
Patch() yöntemleri, API çağrısı yanıtında güncellenen kaynağın tüm örneğini, tüm değişiklikler tamamlanmış şekilde döndürür.
Get ve list
Kaynakları almak için iki yöntem vardır: get() ve list().
get() yöntemi, belirli bir tanımlayıcıya göre belirli bir kaynağı alır. Örneğin, id veya alias'a göre bir Course getirme. get() çağrısı, kaynağın tamamını doğrudan döndürür.
list() yöntemi, tek bir istekte aynı türden birden fazla kaynağı, ayrı kaynak tanımlayıcılarına gerek kalmadan alır. Genellikle list() işlemi, bazı üst kaynakların tüm alt kaynaklarını alır. Örneğin, bir Course içindeki tüm CourseWork öğelerini alır. Bu yöntem, birden fazla get() çağrısı yapmak yerine istekleri en aza indirmek için kullanışlıdır ve özellikle istediğiniz kaynakların id değerini bilmediğinizde değerlidir.
Genellikle list() yöntemleri, tek bir çağrıda döndürülebilecek belirli bir maksimum kaynak miktarına sahiptir ve çağrıya bir pageSize değeri ekleyerek alt sınırlar yapılandırılabilir. Sınırdan daha fazla kaynak olduğunda list() yöntemi sayfalara ayırmayı destekler. Döndürülen her sonuç "sayfası" bir pageToken sağlar. Bu pageToken, sonraki kaynak grubunu almak için sonraki bir list() çağrısına dahil edilebilir.
Sil
delete() yöntemi, id gibi bir kaynak tanımlayıcıyı kabul eder ve ilgili kaynağı siler. delete() başarılı olursa boş bir yanıt döndürülür.
Diğer işlemler
Classroom API ile yapılabilecek tüm işlemler, yukarıda belirtilen standart işlemlerle gerçekleştirilemez. Örneğin, bir CourseWork kaynağının atanmışlarını değiştirmek mümkün değildir. Bu durumlarda modifyAssignees yöntemi gibi özel yöntemler kullanılabilir. Bu yöntemlerin davranışı özeldir ve her birinin dokümanlarına ayrı ayrı bakmanız gerekir.