Classroom API, Google Classroom'daki kursları ve loşlukları yönetmeniz için RESTful bir arayüz sunar. Ayrıca Classroom paylaşım düğmesi, geliştiricilerin ve içerik sahiplerinin içeriklerini Classroom ile paylaşabilmelerini sağlar.
API'yi kimler kullanabilir?
Google Workspace for Education alan yöneticileri; API'yi öğretmenler adına programatik olarak sağlamak, öğrenci bilgi sistemlerini Classroom ile senkronize etmek ve alanlarında eğitim verilen sınıflarla ilgili temel bilgileri edinmek için kullanabilir.
Uygulama geliştiriciler, uygulamalarını Classroom ile entegre etmek için Classroom API'yi kullanabilir. Bu uygulamaların, öğretmenlerden sınıfları ve öğrenci listelerini görüntüleme izni istemek için OAuth 2.0'ı kullanması gerekir. Alanlarındaki öğretmen ve öğrencilerin Google Classroom verilerine erişmesi için uygulamaları yetkilendirip yetkilendiremeyeceklerini kısıtlayabilir.
Web sitesi sahipleri ve içerik geliştiriciler, öğrencilerin ve öğretmenlerin Classroom'da içerik paylaşmalarına izin vermek için Classroom paylaşım düğmesini kullanabilir.
Tüm API ve Classroom paylaşım düğmesi entegrasyonları, Classroom marka yönergelerine uygun olmalıdır.
API'ye genel bakış
Classroom API, Classroom arayüzündeki sınıflara, öğretmenlere ve öğrencilere karşılık gelen çeşitli öğe türlerinden oluşur. Bu öğelerden bazıları, Classroom'dakilerin yanı sıra API'ye özgü ek özelliklere sahiptir. Birincil varlık türleri şunlardır:
- Kurslar
- Takma adlar
- Davetiyeler
- Öğrenciler
- Öğretmenler
- Kullanıcı profilleri
- Sınıf çalışması
- Konular
- Öğrenci gönderimleri
API kaynakları ve yöntemleri hakkında ayrıntılı bilgi için Classroom API referansına bakın.
Kurs meta verileri ve takma adları
Kurslar "M. Smith'in 4. dönem matematiği" vardı. Her kurs, sunucu tarafından atanan benzersiz bir kimlikle tanımlanır. Kurs kaynağı özellikle ad, açıklama, konum ve zaman gibi kursla ilgili meta verilerin tamamını kapsar. Kurs öğrenci listeleri Öğrenci, Öğretmen ve Davetiye kaynakları ve bunların yöntemleri üzerinden yönetilir.
Takma adlar, bir sınıfla ilişkilendirilebilecek ve benzersiz kimliğin yerine kullanılabilecek sınıf için alternatif tanımlayıcılardır. Her takma ad, takma ad oluşturabilecek ve görüntüleyebilecek kişileri sınırlayan bir ad alanında yer alır. İki ad alanı desteklenir:
- Alan adı: Alan ad alanı, tüm kullanıcıların erişmesi gereken, ancak tek bir programa özel olmayan takma adlar oluşturmak için yararlıdır. Örneğin, MATH 127 ve COMSCI 127 gibi bir kurs için alternatif girişler, alan ad alanında oluşturulmalıdır. Alan ad alanındaki takma adlar yalnızca alan yöneticileri tarafından oluşturulabilir ancak bir alandaki tüm kullanıcılar tarafından görülebilir.
- Geliştirici projesi: Geliştirici projesi ad alanı, bir uygulamaya özgü takma adların yönetilmesinde yararlıdır. Örneğin, kurslar için alternatif tanımlayıcılar kullanan bir uygulama, tanımlayıcısını Classroom dersleriyle eşlemek için takma adlar oluşturabilir. Bu ad alanında oluşturulan takma adlar, belirli bir Google API Konsolu'na bağlıdır. Bir uygulamanın tüm kullanıcıları, söz konusu uygulamanın geliştirici projesinin ad alanında takma adlar oluşturup görüntüleyebilir.
Kurs meta verilerini ve takma adları yönetme hakkında daha fazla bilgi için Kursları Yönetme başlıklı makaleye bakın.
Kurs öğrenci listeleri ve kullanıcıları
Öğrenciler ve Öğretmenler, bir kullanıcı profili ile ders arasında gerçekleştirilen belirli eşlemelerdir ve bunlar, kullanıcının dersteki rolünü temsil eder. Öğrenci ve öğretmen tanımlamaları küresel değildir: Bir kullanıcı bir ders için öğretmen, diğer bir öğrenci için de öğrenci olarak atanabilir. "Öğrenci" veya "öğretmen" tanımlaması, belirli bir kurstaki belirli bir kullanıcı için bir dizi izni temsil eder.
- Öğrenciler
- Öğrenci kaynağı, belirli bir kursa öğrenci olarak kaydolmuş bir kullanıcıyı temsil eder. Öğrencilerin ders ayrıntılarını ve dersin öğretmenlerini görüntülemesine izin verilir.
- Öğretmenler
- Öğretmen kaynağı, belirli bir kursu sunan bir kullanıcıyı temsil eder. Öğretmenlerin kurs ayrıntılarını görüntülemesine ve değiştirmesine, öğretmen ve öğrencileri görüntülemesine, diğer öğretmenleri ve öğrencileri yönetmesine izin verilir.
Davetler ve bunlarla ilgili yöntemler, öğrencilere ve öğretmenleri derslere eklemenin kolay bir yoludur. Davetiyeler oluşturmak, kullanıcıların doğrudan öğretmen ve öğrenci kaynakları üzerinden eklemek yerine bir derse katılıp katılmamayı seçmesine olanak tanır.
UserProfiles, kullanıcının Directory API tarafından döndürülen benzersiz kimliği veya e-posta adresiyle tanımlandığı, alan profiline eşlenenleri temsil eder.
Ayrıca, geçerli kullanıcı "me" kısaltmasını kullanarak kendi kimliğine de başvurabilir.
Öğrenci listelerini yönetme hakkında daha fazla bilgi için Öğretmenleri ve Öğrencileri Yönetme başlıklı makaleyi inceleyin.
Sınıf çalışması ve öğrenci gönderimleri
CourseWork öğesi, dersteki bir grup öğrenciye atanan tek bir görevi temsil eder. Açıklamada, son tarih ve materyal gibi bilgilerin yanı sıra oluşturulma zamanı gibi meta veriler de yer alır. Materyaller başlık, küçük resim ve URL'nin yanı sıra uygun API'lerle (ör. Drive, YouTube) kullanılabilecek bir tanımlayıcı içerir.
CourseWork öğeleri, aşağıdaki görev türlerinden birini tanımlar:
- Öğrencilerin çalışma sayfaları veya diğer ekler göndererek tamamladığı ödevler.
- Kısa yanıtlı bir soru veya çoktan seçmeli bir soru.
CourseWork öğeleri için öğrenci çalışmaları StudentSubmission değeriyle gösterilir. Bir yanıtın yanı sıra eyalet ve atanan not gibi ek meta verilerden oluşur.
StudentSubmission içeriği, ilgili CourseWork öğesinin türüne bağlıdır:
- Başlık, küçük resim ve URL'nin yanı sıra Drive veya YouTube gibi uygun API'lerle kullanılabilen tanımlayıcılar dahil olmak üzere bir ödev için gönderilen çalışma sayfaları ve ekler.
- Kısa yanıtlı bir soruya veya çoktan seçmeli bir soruya verilen yanıt.
Sınıf çalışmalarını ve öğrenci gönderimlerini yönetme hakkında daha fazla bilgi edinmek için Sınıf Çalışmaları'nı yönetme başlıklı makaleye göz atın.
Hızlı Başlangıç Kılavuzları
Ortamınızı oluşturmak ve API'yi hemen kullanmaya başlamak için hızlı başlangıç kılavuzlarından birini deneyin:
Classroom API Gezgini ile deneme yapma
Canlı verilerde çağrı yöntemlerini denemek için Classroom API Gezgini'ni kullanmayı deneyin. Başlamak için herhangi bir kod yazmanız gerekmez. Ancak API Gezgini'ni kullanarak gerçekleştirdiğiniz işlemlerin mevcut verileri değiştirebileceğini unutmayın.
Yöntemleri çağırmaya başlamanın bir yolu, courses.list() yöntemini çağırmaktır. Bu yöntem herhangi bir istek parametresi gerektirmez. Diğer API çağrıları için istek parametresi olarak kullanılacak, döndürülen kurs listesinden id alabilirsiniz. Kursunuz yoksa courses.create() yöntemini kullanarak bir kurs oluşturabilirsiniz.
Ayrıca API referansını da inceleyebilirsiniz.