Google Classroom API

Google Classroom'da sınıfları, öğrenci listelerini ve davetiyeleri yönetir.

Hizmet: classroom.googleapis.com

Bu hizmeti çağırmak için Google tarafından sağlanan istemci kitaplıklarını kullanmanızı öneririz. Uygulamanızın bu hizmeti çağırmak için kendi kitaplıklarınızı kullanması gerekiyorsa API istekleri oluştururken aşağıdaki bilgileri kullanın.

Keşif dokümanı

Keşif Belgesi, REST API'lerini tanımlamaya ve kullanmaya yönelik, makine tarafından okunabilir bir spesifikasyondur. İstemci kitaplıkları, IDE eklentileri ve Google API'leriyle etkileşimde bulunan başka araçlar oluşturmak için kullanılır. Bir hizmet, birden fazla keşif belgesi sağlayabilir. Bu hizmet, aşağıdaki keşif dokümanını sağlar:

Hizmet uç noktası

Hizmet uç noktası, bir API hizmetinin ağ adresini belirten bir temel URL'dir. Bir hizmet, birden fazla hizmet uç noktasına sahip olabilir. Bu hizmet, aşağıdaki hizmet uç noktasına sahiptir ve aşağıdaki tüm URI'lar bu hizmet uç noktasıyla ilişkilidir:

  • https://classroom.googleapis.com

REST Kaynağı: v1.courses

Yöntemler
checkAddOnCreationEligibility GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Kullanıcının belirli bir kursta eklenti ekleri oluşturmaya uygun olup olmadığını döndürür.
create POST /v1/courses
Ders oluşturur.
delete DELETE /v1/courses/{id}
Dersi siler.
get GET /v1/courses/{id}
Kurs döndürür.
list GET /v1/courses
İstekte bulunan kullanıcının görüntüleme iznine sahip olduğu kursların listesini, istekle eşleşenlerle kısıtlı şekilde döndürür.
patch PATCH /v1/courses/{id}
Kurstaki bir veya daha fazla alanı günceller.
update PUT /v1/courses/{id}
Bir kursu günceller.

REST Kaynağı: v1.courses.aliases

Yöntemler
create POST /v1/courses/{courseId}/aliases
Ders için takma ad oluşturur.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Dersin takma adını siler.
list GET /v1/courses/{courseId}/aliases
Dersin takma adlarının listesini döndürür.

REST Kaynağı: v1.courses.announcements

Yöntemler
create POST /v1/courses/{courseId}/announcements
Duyuru oluşturur.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Duyuruyu siler.
get GET /v1/courses/{courseId}/announcements/{id}
Duyuru döndürür.
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
Belirli bir yayın bağlamında Classroom eklentilerinin meta verilerini alır.
list GET /v1/courses/{courseId}/announcements
İstekte bulunan kişinin görüntülemesine izin verilen duyuruların listesini döndürür.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Atanan modunu ve duyuru seçeneklerini değiştirir.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Duyurunun bir veya daha fazla alanını günceller.

REST Kaynağı: v1.courses.announcements.addOnAttachments

Yöntemler
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Bir yayının altında eklenti eki oluşturur.
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Eklenti ekini siler.
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Eklenti ekini döndürür.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Yayının altında eklentiler tarafından oluşturulan tüm ekleri döndürür.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Eklenti ekini günceller.

REST Kaynağı: v1.courses.courseWork

Yöntemler
create POST /v1/courses/{courseId}/courseWork
Sınıf çalışması oluşturur.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Sınıf çalışmasını siler.
get GET /v1/courses/{courseId}/courseWork/{id}
Sınıf çalışmasını geri verir.
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
Belirli bir yayın bağlamında Classroom eklentilerinin meta verilerini alır.
list GET /v1/courses/{courseId}/courseWork
İstekte bulunan kişinin görüntülemesine izin verilen sınıf çalışmalarının listesini döndürür.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Sınıf çalışmasının atanan modunu ve seçeneklerini değiştirir.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Sınıf çalışmasının bir veya daha fazla alanını günceller.

REST Kaynağı: v1.courses.courseWork.addOnAttachments

Yöntemler
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Bir yayının altında eklenti eki oluşturur.
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Eklenti ekini siler.
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Eklenti ekini döndürür.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Yayının altında eklentiler tarafından oluşturulan tüm ekleri döndürür.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Eklenti ekini günceller.

REST Kaynağı: v1.courses.courseWork.addOnAttachments.studentSubmissions

Yöntemler
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Eklenti eki için öğrenci gönderimini döndürür.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Eklenti eki gönderme işlemiyle ilişkili verileri günceller.

REST Kaynağı: v1.courses.courseWork.rubrics

Yöntemler
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
Puan anahtarı oluşturur.
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Puan anahtarını siler.
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Bir puan anahtarı döndürür.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
İstekte bulunan kişinin görüntülemesine izin verilen puan anahtarlarının listesini döndürür.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Bir puan anahtarını günceller.

REST Kaynağı: v1.courses.courseWork.studentSubmissions

Yöntemler
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Öğrencinin gönderdiği çalışmayı döndürür.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
İsteğin OAuth kapsamları da hesaba katılarak, istekte bulunan kişinin görüntülemesine izin verilen öğrenci gönderimlerinin listesini döndürür.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Öğrencinin gönderdiği gönderim eklerinde değişiklik yapar.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Öğrenci gönderiminin bir veya daha fazla alanını günceller.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Öğrencinin, sahibi olduğu öğrenci adına gönderimini geri alır.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Öğrencinin gönderdiği çalışmayı döndürür.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Öğrencinin gönderdiği çalışmayı teslim eder.

REST Kaynağı: v1.courses.courseWorkMaterials

Yöntemler
create POST /v1/courses/{courseId}/courseWorkMaterials
Sınıf çalışması materyali oluşturur.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
Sınıf çalışması materyalini siler.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Sınıf çalışması materyalini döndürür.
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
Belirli bir yayın bağlamında Classroom eklentilerinin meta verilerini alır.
list GET /v1/courses/{courseId}/courseWorkMaterials
İstekte bulunan kişinin, görüntülemesine izin verilen sınıf çalışması materyallerinin listesini döndürür.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Sınıf çalışması materyalinin bir veya daha fazla alanını günceller.

REST Kaynağı: v1.courses.courseWorkMaterials.addOnAttachments

Yöntemler
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Bir yayının altında eklenti eki oluşturur.
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Eklenti ekini siler.
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Eklenti ekini döndürür.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Yayının altında eklentiler tarafından oluşturulan tüm ekleri döndürür.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Eklenti ekini günceller.

REST Kaynağı: v1.courses.posts

Yöntemler
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
Belirli bir yayın bağlamında Classroom eklentilerinin meta verilerini alır.

REST Kaynağı: v1.courses.posts.addOnAttachments

Yöntemler
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Bir yayının altında eklenti eki oluşturur.
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Eklenti ekini siler.
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Eklenti ekini döndürür.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Yayının altında eklentiler tarafından oluşturulan tüm ekleri döndürür.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Eklenti ekini günceller.

REST Kaynağı: v1.courses.posts.addOnAttachments.studentSubmissions

Yöntemler
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Eklenti eki için öğrenci gönderimini döndürür.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
Eklenti eki gönderme işlemiyle ilişkili verileri günceller.

REST Kaynağı: v1.courses.students

Yöntemler
create POST /v1/courses/{courseId}/students
Kullanıcıyı dersin öğrencisi olarak ekler.
delete DELETE /v1/courses/{courseId}/students/{userId}
Bir dersin öğrencisini siler.
get GET /v1/courses/{courseId}/students/{userId}
Bir dersin öğrencisini döndürür.
list GET /v1/courses/{courseId}/students
İstekte bulunan kişinin görüntülemesine izin verilen bu kurstaki öğrencilerin listesini döndürür.

REST Kaynağı: v1.courses.teachers

Yöntemler
create POST /v1/courses/{courseId}/teachers
Dersin öğretmenini oluşturur.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Belirtilen öğretmeni belirtilen dersten kaldırır.
get GET /v1/courses/{courseId}/teachers/{userId}
Dersin öğretmenini döndürür.
list GET /v1/courses/{courseId}/teachers
İstekte bulunan kişinin görüntüleme iznine sahip olduğu bu kurstaki öğretmenlerin listesini döndürür.

REST Kaynağı: v1.courses.topics

Yöntemler
create POST /v1/courses/{courseId}/topics
Konu oluşturur.
delete DELETE /v1/courses/{courseId}/topics/{id}
Konuyu siler.
get GET /v1/courses/{courseId}/topics/{id}
Bir konu döndürür.
list GET /v1/courses/{courseId}/topics
İstekte bulunan kişinin görüntülemesine izin verilen konuların listesini döndürür.
patch PATCH /v1/courses/{courseId}/topics/{id}
Bir konunun bir veya daha fazla alanını günceller.

REST Kaynağı: v1.invitations

Yöntemler
accept POST /v1/invitations/{id}:accept
Davetiyeyi kabul eder ve davet edilen kullanıcıyı belirtilen dersin öğretmen veya öğrencilerine (uygun olduğu şekilde) ekler.
create POST /v1/invitations
Davetiye oluşturur.
delete DELETE /v1/invitations/{id}
Davetiyeyi siler.
get GET /v1/invitations/{id}
Bir davetiye döndürür.
list GET /v1/invitations
İstekte bulunan kullanıcının görüntülemesine izin verilen davetiyelerin, liste isteğiyle eşleşenlerle sınırlı bir listesini döndürür.

REST Kaynağı: v1.registrations

Yöntemler
create POST /v1/registrations
Registration oluşturarak Classroom'un, sağlanan feed öğesinden cloudPubSubTopic içinde sağlanan hedefe bildirim göndermeye başlamasına neden olur.
delete DELETE /v1/registrations/{registrationId}
Bir Registration silindiğinde Classroom söz konusu Registration için bildirim göndermeyi durdurur.

REST Kaynağı: v1.userProfiles

Yöntemler
get GET /v1/userProfiles/{userId}
Bir kullanıcı profili döndürür.

REST Kaynağı: v1.userProfiles.guardianInvitations

Yöntemler
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Bir veli davetiyesi oluşturur ve veliye bir e-posta göndererek öğrencinin velisi olduğunu onaylamasını ister.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Belirli bir veli davetiyesi geri gönderilir.
list GET /v1/userProfiles/{studentId}/guardianInvitations
İstekte bulunan kullanıcının görüntülemesine izin verilen veli davetiyelerinin, sağlanan parametrelere göre filtrelenmiş bir listesini döndürür.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Veli davetiyesinde değişiklik yapar.

REST Kaynağı: v1.userProfiles.guardians

Yöntemler
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
Veliyi siler.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Belirli bir veliyi iade eder.
list GET /v1/userProfiles/{studentId}/guardians
İstekte bulunan kullanıcının görüntülemesine izin verilen velilerin, istekle eşleşenlerle sınırlı olacak şekilde bir listesini döndürür.