Bu sayfada, Google Classroom API'de isteklerin nasıl çalıştığına dair genel bir bakış sunulmaktadır. Bu dokümanın amacı, kaynağa yönelik tasarım veya Google Workspace API'leri hakkında bilgisi olmayan okuyuculara yardımcı olmaktır.
Belirli kod örnekleri için ilgili API kılavuzlarına (ör. Kurs oluşturma ve yönetme veya Ödev oluşturma ve yönetme) bakın.
Kaynak odaklı tasarım
API kaynakları bölümünde belirtildiği gibi Classroom API, kaynağa dayalı tasarım kalıplarını kullanır. Çoğu kaynakta, kaynağın örneklerini oluşturma, okuma, güncelleme ve silme gibi standart işlemler için yöntemler bulunur.
Örneğin, API'yi kullanarak Classroom Course'inde create(), patch(), get(), list() ve delete() işlemleri yapılabilir.
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 ilgili kaynağın ilk ve kritik ayrıntılarını giriş olarak gerektirir. Örneğin, Course oluşturmak için Course kaynağında create() yöntemini çağırın ve istekte name ile description'ü, room gibi isteğe bağlı bilgilerle birlikte belirtin.
Alt kaynaklar (bazen alt öğe kaynakları olarak da adlandırılır) için üst kaynak tanımlayıcıları da gereklidir. Örneğin, Course içinde CourseWork oluştururken CourseWork'ın hangi Course'a ait olduğunu belirlemek için Course id gerekir.
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 kaynak genellikle kaynak id veya creationTime gibi ek sunucu tarafından oluşturulan alanlara sahiptir.
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, iki temel fark dışında create() ile neredeyse aynıdır. patch() yöntemi çağrılırken şunlar belirtilmelidir:
- Değiştirilecek kaynağın
id. - Kaynakta hangi alanların güncelleneceğini belirlemek için kullanılan ve
updateMaskolarak adlandırılan bir alan listesi. Varsayılan bir alan kümesinin olduğu veya alanların çıkarıldığı durumlarda bu isteğe bağlıdır.
Patch() yöntemleri, API çağrısı yanıtında güncellenen kaynağın tam örneğini döndürür ve tüm değişiklikler tamamlanır.
Alma ve listeleme
Kaynakları almanın iki yöntemi vardır: get() ve list().
get() yöntemi, belirli bir kaynağı tanımlayıcıya göre alır. Örneğin, id veya alias temelinde 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, bir üst kaynağı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ı yapmaya kıyasla istekleri en aza indirmek için yararlıdır ve özellikle istediğiniz kaynakların id'ını bilmediğiniz durumlarda değerlidir.
Genellikle, list() yöntemlerinde tek bir çağrıda döndürülebilecek maksimum kaynak miktarı vardır ve çağrıya bir pageSize değeri eklenerek daha düşük sınırlar yapılandırılabilir. Sınırın üzerinde kaynak olduğu durumlarda list() yöntemi sayfalara ayırmayı destekler. Döndürülen her sonuç "sayfası" bir pageToken sağlar. Bu pageToken, sonraki kaynak grubunu getirmek için sonraki list() çağrısına eklenebilir.
Sil
delete() yöntemi, id gibi bir kaynak tanımlayıcıyı kabul eder ve karşılık gelen kaynağı siler. delete() başarılı olursa boş bir yanıt döndürülür.
Diğer işlemler
Classroom API ile mümkün olan tüm işlemler, yukarıda belirtilen standart işlemlerle gerçekleştirilemez. Örneğin, CourseWork kaynağının atananlarını değiştirme işlemi bu kapsamda yer alır. Bu gibi 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.