Genel bakış

Classroom API, Google Classroom'daki dersleri ve öğrenci değerlendirmelerini yönetebilmeniz için RESTful arayüzü sağlar. Ayrıca Classroom paylaş düğmesi, geliştiricilerin ve içerik sahiplerinin içeriklerini Classroom ile paylaşmalarını etkinleştirmelerine olanak tanır.

API'yi kimler kullanabilir?

Google Workspace for Education alan yöneticileri API'yi kullanarak öğretmenler adına derslerin temel hazırlığını programatik olarak yapabilir, öğrenci bilgi sistemlerini Classroom ile senkronize edebilir ve alanlarında eğitim verilen sınıflarla ilgili temel görünürlük elde edebilir.

Uygulama geliştiriciler, uygulamalarını Classroom'a 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, kendi Google Classroom verilerine erişmesi için uygulamaları yetkilendirip yetkilendiremeyeceğini yöneticiler kısıtlayabilir.

Web sitesi sahipleri ve içerik geliştiricileri, öğrencilerin ve öğretmenlerin tekrar Classroom'da içerik paylaşmasına olanak tanımak için Classroom paylaş 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 varlık türlerinden oluşur. Bu varlıklardan bazılarının, Classroom'dakilere ek olarak API'ye özel ek özellikleri vardır. Birincil varlık türleri şunlardır:

API'nin kaynakları ve yöntemleri hakkında ayrıntılı bilgi için Classroom API referansı başlıklı makaleye bakın.

Ders meta verileri ve takma adları

Kurslar, "M. Smith'in 4. dönem matematiği" ve atanmış öğretmenleri, öğrenci listesi ve meta verileri. Her kurs, sunucu tarafından atanan benzersiz bir kimlikle tanımlanır. Kurs kaynağı, özellikle kursla ilgili ad, açıklama, konum ve saat gibi tüm meta verileri içerir. Kurs listeleri; Öğrenci, Öğretmen ve Davetiye kaynakları ve yöntemleri aracılığıyla yönetilir.

Takma adlar, bir kursla ilişkilendirilebilecek ve benzersiz kimlik yerine kullanılabilecek alternatif tanımlayıcılardır. Her takma adı, kimlerin oluşturabileceğini ve görüntüleyebileceğini kısıtlayan bir ad alanında bulunur. İki ad alanı desteklenir:

Alan adı: Alan adı alanı, tüm kullanıcıların erişmesi gereken ancak herhangi bir programa özel olmayan takma adlar oluşturmak için kullanışlıdır. Örneğin, alan ad alanında MATH 127 ve COMSCI 127 gibi bir kursa ait alternatif girişler 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 özel takma adları yönetmek için kullanışlıdır. Örneğin, dersler 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şturabilir ve görüntüleyebilir.

Kurs meta verilerini ve takma adları yönetme hakkında daha fazla bilgi için Dersleri Yönetme bölümüne bakın.

Ders listeleri ve kullanıcıları

Öğrenciler ve Öğretmenler, kullanıcı profili ile kurs arasında yapılan ve kullanıcının kurstaki rolünü temsil eden belirli eşlemelerdir. Öğrenci ve öğretmen atamaları genel değildir: Bir kullanıcı bir derste öğretmen, başka bir derste ise öğrenci olarak atanabilir. "Öğrenci" veya "öğretmen" ataması belirli bir kurstaki belirli bir kullanıcıya verilen izin grubunu temsil eder.

Öğrenciler: Öğrenci kaynağı, belirli bir kursa öğrenci olarak kaydolmuş kullanıcıları temsil eder. Öğrencilerin söz konusu kursla ilgili kurs ayrıntılarını ve öğretmenleri görüntülemesine izin verilir.
Öğretmenler: Öğretmen kaynağı, belirli bir dersi veren 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, ek öğretmen ve öğrencileri yönetmesine izin verilir.

Davetiyeler ve ilişkili yöntemler, öğrencileri ve öğretmenleri kurslara eklemek için kolay bir yol sağlar. Davetiye oluşturduğunuzda kullanıcılar bir derse doğrudan öğretmen ve öğrenci kaynakları yoluyla değil, derse katılıp katılmama konusunda karar verebilir.

UserProfiles, kullanıcının Directory API tarafından döndürülen benzersiz kimliği veya e-posta adresiyle tanımlanan alan profiliyle eşlemeyi temsil eder. 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ı makaleye bakın.

Sınıf çalışmaları ve öğrenci gönderimleri

CourseWork öğesi, bir dersteki bir grup öğrenciye atanmış tek bir görevi temsil eder. Açıklama, teslim tarihi ve malzemelerin yanı sıra oluşturulma zamanı gibi meta verileri de içerir. Materyaller arasında başlık, küçük resim ve URL'nin yanı sıra uygun API'lerle (ör. Drive, YouTube) kullanılabilecek bir tanımlayıcı da yer alır.

CourseWork öğeleri aşağıdaki görev türlerinden birini tanımlar:

Öğrencilerin çalışma sayfaları veya başka ekler göndererek tamamladığı ödev.
Kısa yanıtlı bir soru veya çoktan seçmeli bir soru.

CourseWork öğesi için öğrenci çalışmaları, StudentSubmission ile temsil edilir. Bir yanıtın yanı sıra durum ve atanan not gibi ek meta verilerden oluşur.

StudentSubmission'ların içeriği, ilgili CourseWork öğesinin türüne bağlıdır:

Bir ödev için gönderilen çalışma sayfaları ve ekler (başlık, küçük resim ve URL'nin yanı sıra Drive veya YouTube gibi uygun API'lerle kullanılabilecek tanımlayıcılar dahil)
Kısa yanıtlı 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ı sayfasını yönetme başlıklı makaleyi inceleyin.

Hızlı Başlangıç Kılavuzları

Ortamınızı ayarlamak ve API'yi kullanmaya hemen başlamak için hızlı başlangıç kılavuzlarından birini deneyin:

Classroom API Explorer ile denemeler yapma

Canlı veriler üzerinde arama yöntemlerini denemek için Classroom API Gezgini'ni kullanmayı deneyin. Başlamak için herhangi bir kod yazmanız gerekmez, ancak API gezginini kullanarak gerçekleştirdiğiniz işlemlerin mevcut verileri değiştirebileceğini lütfen unutmayın.

Yöntemleri çağırmaya başlamanın bir yolu, courses.list() yöntemini çağırmaktır. Bu yöntem için herhangi bir istek parametresi gerekmez ve döndürülen kurs listesinden bir id alarak diğer API çağrıları için istek parametresi olarak kullanabilirsiniz. Hiç kursunuz yoksa courses.create() yöntemini kullanarak bir kurs oluşturabilirsiniz.

Ayrıca API referansını da inceleyebilirsiniz.