API kaynakları

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

Varlık	Classroom'da gösterim
Kurslar	"M. Smith's 4th period math" (Smith'in 4. ders matematik sınıfı).
Diğer adlar	Kurs için alternatif bir kimlik.
Davetiyeler	Kullanıcıları sınıfa ekleme yöntemi
Öğrenciler	Bir sınıftaki öğrenci.
Öğretmenler	Bir sınıftaki öğretmen
Kullanıcı profilleri	Öğrenci veya öğretmen bağlamı dışında, daha genel anlamda bir kullanıcı.
CourseWork	Bir sınıftaki ödev.
StudentSubmissions	Öğrencilerin belirli bir ödevle ilgili çalışmaları (ör. yanıtlar veya çalışma sayfaları)
CourseWorkMaterials	Bir sınıftaki öğrenciler için materyaller.
Duyurular	Bir sınıftaki öğrencilere yönelik duyuru
AddOnAttachment	Genellikle yerleştirilmiş bir iFrame olarak gösterilen bir ödev veya materyaldeki içerik ya da etkinlik.
Konular	Bir sınıftaki ödevlerin ve materyallerin görsel gruplandırması.
Kayıtlar	Verilerde (ör. sınıf listesi) yapılan değişiklikler için 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 ödevin atandığı öğ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 bakın.

Kaynak ilişkilerine genel bakış

• Kurs, Google Classroom'daki temel veri nesnesidir.
• Courses için alternatif tanımlayıcı olarak takma adlar kullanılır.
• Davetiyeler, kullanıcı profillerini Course'da öğretmen veya öğrenci olmaya davet etmek için kullanılır. Bununla birlikte, kullanıcılar doğrudan Google Workspace for Education alan yöneticileri tarafından da eklenebilir.
• Öğretmenler Akış öğeleri oluşturur ve bunları kurslarındaki öğrencilerle paylaşır. Olası akış öğesi türleri Coursework, CourseWorkMaterials ve Announcements'dır. CourseWork ve CourseWorkMaterials, görsel olarak Konular halinde düzenlenebilir ve AddOnAttachments 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 alanlarda kullanılabilir. Classroom bağlamında alan genellikle bir okul bölgesini temsil eder. Geliştirme amacıyla Google Workspace for Education test alanı oluşturabilirsiniz. Bu sayede, gerçek kullanıcıları etkilemeden Classroom'un üretim örneğini kontrol edebilirsiniz.

Kurslar ve Takma Adlar

Courses, "M. Smith'in 4. ders matematik sınıfı" ve bu sınıfa atanan öğretmenler, öğrenci listesi ve meta veriler. Her kurs, sunucu tarafından atanan benzersiz bir kimlikle tanımlanır. Course kaynağı, özellikle kursla ilgili tüm meta verileri (ör. ad, açıklama, konum ve zaman) kapsar. Kurs öğrenci listeleri Öğrenci, Öğretmen ve Davet kaynakları ve yöntemleri aracılığıyla yönetilir.

Aliases, bir kursla ilişkilendirilebilen ve benzersiz kimlik yerine kullanılabilen alternatif sınıf tanımlayıcılarıdı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 özgü olmayan takma adlar oluşturmak için kullanışlıdır. Örneğin, MATH 127 ve COMSCI 127 gibi bir kursun alternatif listelemeleri 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 özel 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 herhangi bir kullanıcısı, bu uygulamanın geliştirici projesinin ad alanında takma adlar oluşturabilir ve görüntüleyebilir.

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

Kurs öğrenci listeleri ve kullanıcıları

Students ve Teachers, bir kullanıcı profili ile bir kurs arasındaki belirli eşlemelerdir ve kullanıcının kurstaki rolünü gösterir. Öğrenci ve öğretmen tanımları genel değildir: Bir kullanıcı bir kursta öğretmen, başka bir kursta ise öğrenci olarak atanabilir. "Öğrenci" veya "öğretmen" tanımlaması, belirli bir kurstaki belirli bir kullanıcının izinlerini ifade eder. Bir kursta birden fazla öğretmen veya hiç öğrenci olmayabilir. Öğretmenler ve öğrenciler kursa istedikleri zaman eklenebilir veya kurstan çıkarılabilir.

Öğrenciler

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

Öğrenciler, ilgili dersin ayrıntılarını ve öğretmenlerini görüntüleyebilir.

Öğretmenler

Teacher kaynağı, belirli bir kursu öğreten 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, ek öğretmenleri ve öğrencileri yönetmesine izin verilir.

Invitations ve ilişkili yöntemleri, kurslara öğrenci ve öğretmen eklemenin kolay bir yolunu sunar. Davetiye oluşturduğunuzda kullanıcılar, kursa katılıp katılmamayı seçebilir. Bu durumda, öğretmen ve öğrenci kaynakları aracılığıyla kullanıcıları doğrudan eklemeniz gerekmez.

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

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

Sınıf listelerini yönetme hakkında daha fazla bilgi için Öğretmenleri ve Öğrencileri Yönetme başlıklı makaleyi inceleyin.

Akış öğeleri

Akış öğeleri, yayınlanan ve kurs üyeleriyle paylaşılan içeriklerdir. Geliştiriciler ve öğretmenler üç tür akış öğesi oluşturabilir: Announcement, CourseWork ve CourseWorkMaterial.

Öğretmenler, Classroom kullanıcı arayüzündeki Akış sayfasının en üstünde Announcements oluşturur. Öğretmenler, Sınıf Çalışmaları sekmesindeki Oluştur düğmesini tıklayarak CourseWork ve CourseWorkMaterials oluşturur. Geliştiriciler, Classroom API aracılığıyla tüm akış öğesi türlerini programlı olarak oluşturabilir.

Akış öğeleriyle ilgili olarak aşağıdakiler doğrudur:

• Tüm akış öğeleri; Google Drive dosyaları, YouTube videoları, Google Formlar, URL köprüleri ve Classroom eklenti ekleri gibi ek materyaller içerebilir.
• Tüm akış öğeleri, kurstaki öğrencilerin bir alt kümesine atanabilir.
• CourseWork notlu veya notsuz olabilir. Öğretmenler, CourseWork ödevinin notlandırma durumunu istedikleri zaman değiştirebilir.
• Bir akış öğesinde birden fazla ek olabilir.
• Bir akış öğesinde farklı türlerde ekler olabilir. Örneğin, bir ödevde aynı anda Google Drive dosyaları, YouTube videoları ve Classroom eklenti ekleri olabilir.CourseWork
• Bir akış öğesinde birden fazla geliştiricinin eklenti ekleri olabilir.
• Geliştiriciler, eklenti eklerinden birine sahip olan tüm akış öğesi kaynaklarıyla ilgili ayrıntıları alabilir ve değiştirebilir.
• Geliştiriciler, kendi eklenti eklerini içeren bir CourseWork ödev için öğrenci gönderimini teslim edebilir, geri alabilir veya geri verebilir.
• Geliştiriciler, yalnızca oluşturdukları ödevlerdeki ayrı ayrı öğrenci gönderimlerinin notlarını tamamlayabilir.

Kopyalanan yayın öğeleri

Öğretmenler, bir kursu kopyalayarak, bir ödevi yeniden kullanarak veya bir akış öğesini birden fazla kursta yayınlayarak akış öğelerini kopyalayabilir. Yeni kopyaların her birinde farklı tanımlayıcılar bulunur. Bu, Classroom eklentisi geliştiriyorsanız önemli bir nokta olabilir. Bir eklentinin bu senaryoları nasıl ele alabileceğini anlamak için kopyalanmış içerik hakkındaki kılavuzumuzu inceleyin.

CourseWork ve StudentSubmissions

CourseWork öğesi, bir kurstaki bir grup öğrencinin ödevini temsil eder. Öğrenci gönderimini kabul edebilen tek akış öğesi türüdür. Bir CourseWork kaynak; açıklama, son tarih, maksimum not ve oluşturulma zamanı gibi meta veriler gibi ayrıntıları içerir.

Her CourseWork kaynağı, 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 soru

CourseWork öğesiyle ilgili öğrenci çalışması StudentSubmission ile gösterilir. 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 ve şunları içerebilir:

• Ödev için gönderilen çalışma sayfaları ve ekler (başlık, küçük resim 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 sorulara verilen yanıt.

Kurs çalışmalarını ve öğrenci gönderimlerini yönetme hakkında daha fazla bilgi için Kurs çalışmalarını yönetme başlıklı makaleyi inceleyin.

CourseWorkMaterials ve Announcements

CourseWork simgesine benzer şekilde, CourseWorkMaterials simgesi de bir kurstaki öğrenci grubuna atanan içeriği gösterir. Her kaynakta başlık ve açıklama gibi ayrıntıların yanı sıra ek materyaller bulunur. Ancak CourseWork'dan farklı olarak CourseWorkMaterials, öğrencilerin herhangi bir çıktı göndermesini gerektirmez. Bu nedenle, teslim tarihi yoktur ve CourseWorkMaterials için StudentSubmissions yoktur. Öğretmenler, CourseWorkMaterials simgesini kullanarak önerilen okumaları, ders programını veya sınıf kurallarını yayınlayabilir.

Announcements, bir öğrenci grubuyla paylaşılan içerikleri de temsil eder ancak başlık gibi ayrıntıları yoktur ve Topics'ye göre (ör. CourseWork veya CourseWorkMaterials) düzenlenemez. Öğretmenler, sınıfa hatırlatıcılar veya bildirimler duyurmak için bu özelliği kullanabilir.

Konular

Topics, bir sınıftaki CourseWork ve CourseWorkMaterials'yi görsel olarak düzenlemek için kullanılır. Örneğin, bu etiketler ödevleri "isteğe bağlı" ve "zorunlu" ya da "birim 1" ve "birim 2" olarak gruplandırmak için kullanılabilir.

Classroom eklentileri

Eklenti, genellikle bir iFrame'de gösterilen, geliştirici tarafından sunulan bir kullanıcı arayüzü ve arka uçtur. Eklentiler, yayın öğ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, öğrencilerin ayrı bir gönderim yapmasını gerektirir. Örnek olarak testler, çizimler veya oyunlar verilebilir. Etkinlik gönderimi isteğe bağlı olarak notlandırılabilir.
• İçerik ekleri için öğrenci gönderimi gerekmez. Öğrencinin eki teslim etmesi gerekmez ve ek notlandırılmaz. Fotoğraflar, makaleler ve videolar buna örnek olarak verilebilir.

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

Kayıtlar

Uygulamalar, Google Classroom'da belirli veriler değiştiğinde bildirim almak için abone olabilir. Örneğin, bir kursun öğrenci listesi güncellendiğinde. Registrations, bu bildirimlerin uygulamanıza gönderilmesi için bir talimatı temsil eder.

Daha fazla bilgi edinmek için anlık bildirimler kılavuzuna göz atın.