API yapısı

Bu kılavuzda, Google Classroom API'yi oluşturan temel bileşenlere genel bir bakış sunulmaktadır. Google Classroom API, kaynaklardan ve hizmetlerden oluşur. Kaynaklar, Google Classroom'daki öğeleri (ör. kurs veya ödev) temsil eder. Hizmetler ise bu kaynakları alır ve yönetir. Bu öğelerin bazılarında, Classroom'da bulunanlara ek olarak API'ye özgü ek özellikler bulunur. Birincil varlık türleri şunlardır:

Varlık	Classroom'da gösterimi
Kurslar	"M. Yılmaz'ın 4. dönem matematiği".
Takma adlar	Bir dersin alternatif kimliği.
Davetiyeler	Bir sınıfa kullanıcı eklemek anlamına gelir.
Öğrenciler	Sınıftaki bir öğrenci.
Öğretmenler	Sınıftaki bir öğretmen.
Kullanıcı profilleri	Öğrenci veya öğretmen bağlamının dışında, genel anlamda bir kullanıcı.
CourseWork	Bir sınıftaki ödev.
StudentSubmissions	Öğrencilerin belirli bir ödev (ör. yanıtlar veya çalışma sayfaları) için yaptığı çalışmalar.
CourseWorkMaterials	Bir sınıftaki öğrenciler için hazırlanmış materyaller.
Duyurular	Sınıftaki öğrencilere yönelik bir duyuru.
AddOnAttachment	Ödev veya materyaldeki, genellikle yerleştirilmiş bir iframe olarak görüntülenen içerik ya da etkinlik.
Konular	Bir sınıftaki ödev ve materyallerin görsel olarak gruplandırılması.
Kayıtlar	Sınıf listesi gibi verilerdeki değişikliklerle ilgili olarak uygulamanıza bildirim gönderme talimatı.

Çoğu kaynakta, kaynağın örneklerini okuma, güncelleme ve silme gibi standart işlemler için hizmet yöntemleri bulunur. Bazı kaynaklarda, belirli bir ödev atanmış öğrencilerin listesini değiştirme gibi diğer işlemler için özel yöntemler de bulunur.

API kaynakları ve yöntemleri hakkında ayrıntılı bilgi için Classroom API referansına göz atın.

Kaynak ilişkilerine genel bakış

• Ders, Google Classroom'daki temel veri nesnesidir.
• Courses için alternatif tanımlayıcılar olarak takma adlar kullanılır.
• Davetiyeler, kullanıcı profillerini Course'de öğretmen veya öğrenci olmaya davet etmek için kullanılır ancak kullanıcılar doğrudan Google Workspace for Education alan yöneticileri tarafından da eklenebilir.
• Öğretmenler akış öğeleri oluşturup bunları kurslarındaki öğrencilerle paylaşabilir. Olası akış öğesi türleri Coursework, CourseWorkMaterials ve Announcements'dır. CourseWork ve CourseWorkMaterials, Konular şeklinde görsel olarak düzenlenebilir ve AddOnAttachs içerebilir. Öğrenciler CourseWork için StudentSubmissions gönderir.
• Geliştiriciler, bu verilerin bir kısmı değiştiğinde bildirim almak için Kayıtlar oluşturabilir.

Google Classroom, Google Workspace for Education'a abone olan alanları kullanabilir. Classroom bağlamında alan adı genellikle bir okul bölgesini temsil eder. Geliştirme amacıyla bir Google Workspace for Education test alanı oluşturabilirsiniz. Bu, gerçek kullanıcıları etkilemeden Classroom'un üretim örneğini kontrol etmenizi sağlar.

Dersler ve takma adlar

Courses, "M. Smith'in 4. ders matematik" ve bu dersin atanmış öğretmenleri, öğrenci listesi ve meta verileri. Her kurs, sunucu tarafından atanan benzersiz bir kimlikle tanımlanır. Course kaynağı, kursla ilgili tüm meta verileri (ör. ad, açıklama, konum ve saat) kapsar. Ders listeleri, Öğrenci, Öğretmen ve Davet kaynakları ve yöntemleri aracılığıyla yönetilir.

Aliases, bir sınıf için kursla ilişkilendirilebilecek ve benzersiz kimliğin 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: 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, bir dersin alternatif girişleri (ör. MATH 127 ve COMSCI 127) alan ad alanı adında oluşturulmalıdır. Alan adlandırma alanındaki takma adlar yalnızca alan yöneticileri tarafından oluşturulabilir ancak alan adındaki tüm kullanıcılar tarafından görülebilir.
• Geliştirici projesi: Geliştirici projesi ad alanı, bir uygulamaya özgü takma adları yönetmek için kullanışlıdır. Örneğin, kurslar için alternatif tanımlayıcılar kullanan bir uygulama, tanımlayıcısını Classroom kurslarıyla 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 ad oluşturabilir ve görüntüleyebilir.

Kurs meta verilerini ve takma adlarını yönetme hakkında daha fazla bilgi için Kursları yönetme başlıklı makaleyi inceleyin.

Ders listeleri ve kullanıcıları

Students ve Teachers, kullanıcı profili ile kurs arasında belirli eşlemelerdir ve kullanıcının kurstaki rolünü temsil eder. Öğrenci ve öğretmen atamaları genel değildir: Kullanıcılar bir derste öğretmenken başka bir derste de öğrenci olarak atanabilir. "Öğrenci" veya "öğretmen" ifadesi, belirli bir kurstaki belirli bir kullanıcı için bir izin grubunu temsil eder.

Öğrenciler

Student kaynağı, belirli bir kursa öğrenci olarak kayıtlı olan bir kullanıcıyı temsil eder.

Öğrencilerin kurs ayrıntılarını ve öğretmenlerini görüntülemesine izin verilir.

Öğretmenler

Teacher kaynağı, belirli bir kursu veren bir kullanıcıyı temsil eder.

Öğretmenlerin kurs ayrıntılarını görüntülemesine ve değiştirmesine, öğretmenleri ve öğrencileri görüntülemesine ve ek öğretmen ve öğrenci yönetmesine izin verilir.

Invitations ve ilişkili yöntemleri, öğrencilere ve öğretmenlere kurs eklemenin kolay bir yolunu sunar. Davetiye oluşturmak, kullanıcıları öğretmen ve öğrenci kaynakları üzerinden doğrudan eklemek yerine kullanıcıların bir kursa katılıp katılmayacağını seçmelerine olanak tanır.

UserProfiles, Directory API tarafından döndürülen kullanıcının benzersiz kimliği veya e-posta adresi tarafından tanımlanan bir kullanıcının alan profiliyle eşlemeyi temsil eder. Mevcut kullanıcı, "me" kısaltmasını kullanarak kendi kimliğine de atıfta bulunabilir.

UserProfiles hizmeti, öğrenci ile veli arasındaki eşleme olan Guardians öğelerini yönetmek ve davet etmek için de kullanılabilir. Classroom'daki veliler, ödevleri gibi bazı öğrenci bilgilerine erişebilir.

Listeleri 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, bir kurstaki öğrenci grubuna atanan tek bir görevi temsil eder. Açıklama, teslim tarihi ve materyaller gibi ayrıntıların yanı sıra oluşturulma zamanı gibi meta verileri de içerir. Materyallerde başlık, küçük resim ve URL'nin yanı sıra uygun API'lerle (ör. Drive, YouTube) kullanılabilecek bir tanımlayıcı bulunur.

CourseWork öğe aşağıdaki görev türlerinden birini açıklar:

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

CourseWork öğesi için öğrenci çalışması StudentSubmission ile gösterilir. Bir yanıt ve durum ile atanan not gibi ek meta verilerden oluşur.

StudentSubmission öğesinin 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ıkları, küçük resimleri ve URL'leri dahil) ile Drive veya YouTube gibi uygun API'lerle kullanılabilen tanımlayıcılar.
• Kısa yanıtlı veya çoktan seçmeli bir soruya verilen yanıt.

Ödevleri 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ı makaleyi inceleyin.

Ders materyalleri ve duyurular

CourseWork özelliğine benzer şekilde CourseWorkMaterials, bir derste bir öğrenci grubuna atanan içeriği, başlık ve açıklama gibi ayrıntılarla birlikte materyalleri temsil eder. Ancak CourseWork aksine, CourseWorkMaterials öğrencilerin herhangi bir yapı göndermesi gerekmez. Dolayısıyla, CourseWorkMaterials için son tarih yoktur ve StudentSubmissions mevcut değil. Öğretmenler, önerilen okumalar, ders programı veya sınıf kuralları gibi içerikleri yayınlamak için CourseWorkMaterials'ü kullanabilir.

Announcements, bir öğrenci grubuyla paylaşılan içerikleri de temsil eder ancak başlık gibi ayrıntılara sahip değildir ve CourseWork veya CourseWorkMaterials gibi Topics'ye göre düzenlenemez. Öğretmenler, sınıfa hatırlatıcı veya bildirim göndermek için bu araçları kullanabilir.

Konular

Topics, sınıftaki CourseWork ve CourseWorkMaterials öğelerini görsel olarak düzenlemek için kullanılır. Bu etiketler, ödevleri "isteğe bağlı" ve "zorunlu" ya da "1. ünite" ve "2. ünite" şeklinde gruplandırmak için kullanılabilir.

Classroom eklentileri

Eklenti, geliştirici tarafından sunulan bir kullanıcı arayüzü ve arka uçtur ve genellikle bir iFrame'de görüntülenir. Eklentiler, bir akış öğesinde ek olarak görünür. Akış öğesi Announcements, CourseWork veya CourseWorkMaterials olabilir. Eklenti ekleri AddOnAttachment ile gösterilir.

Eklenti ekleri etkinlik veya içerik olabilir.

• Etkinlik ekleri için öğrencinin ayrı bir gönderim tamamlaması ve göndermesi gerekir. Örnekler arasında testler, çekilişler veya oyunlar yer alır. Bir etkinlik gönderimine ise isteğe bağlı olarak not verilebilir.
• İçerik ekleri için öğrenci gönderimi gerekmez. Öğrencinin eki teslim etmesi gerekmez ve ödeve not verilmez. Örnek olarak fotoğraflar, makaleler ve videolar verilebilir.

Daha fazla bilgi için eklenti geliştirme kılavuzlarına bakın.

Kayıtlar

Uygulamalar, Google Classroom'da belirli veriler değiştiğinde bildirimlere abone olabilir. Örneğin, kursun listesi güncellendiğinde. Registrations, bu bildirimlerin uygulamanıza gönderilmesi için bir talimattır.

Daha fazla bilgi için push bildirimleri kılavuzuna göz atın.