Google Classroom API

Google Classroom'daki 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 isteklerini gönderirken aşağıdaki bilgileri kullanın.

Keşif dokümanı

Keşif belgesi, REST API'leri tanımlamak ve kullanmak için makine tarafından okunabilir bir spesifikasyondur. İstemci kitaplıkları, IDE eklentileri ve Google API'leriyle etkileşim kuran diğer araçları oluşturmak için kullanılır. Bir hizmet, birden fazla keşif dokümanı 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 ana URL'dir. Bir hizmetin birden fazla hizmet uç noktası olabilir. Bu hizmetin aşağıdaki hizmet uç noktası vardır ve aşağıdaki tüm URI'ler bu hizmet uç noktasıyla ilgilidir:

  • https://classroom.googleapis.com

REST Kaynağı: v1.courses

Yöntemler
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
Kullanıcının belirli bir kursta eklenti eki oluşturmaya uygun olup olmadığını döndürür.
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
Kullanıcının belirli bir derste GradingPeriodSettings güncellemeye uygun olup olmadığını döndürür.
create POST /v1/courses
Kurs oluşturur.
delete DELETE /v1/courses/{id}
Bir kursu siler.
get GET /v1/courses/{id}
Bir kurs döndürür.
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
Bir dersteki notlandırma dönemi ayarlarını döndürür.
list GET /v1/courses
İstekte bulunan kullanıcının görüntülemesine izin verilen kursların listesini döndürür. Bu liste, istekle eşleşen kurslarla sınırlıdır.
patch PATCH /v1/courses/{id}
Bir kurstaki bir veya daha fazla alanı günceller.
update PUT /v1/courses/{id}
Bir kursu günceller.
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
Dersin notlandırma dönemi ayarlarını 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
Bir kursun takma adlarının listesini döndürür.

REST Kaynağı: v1.courses.announcements

Yöntemler
create POST /v1/courses/{courseId}/announcements
Bir duyuru oluşturur.
delete DELETE /v1/courses/{courseId}/announcements/{id}
Bir duyuruyu siler.
get GET /v1/courses/{courseId}/announcements/{id}
Bir 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ın görüntülemesine izin verilen duyuruların listesini döndürür.
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
Atanan kullanıcı modunu ve duyuru seçeneklerini değiştirir.
patch PATCH /v1/courses/{courseId}/announcements/{id}
Bir 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}
Bir eklenti eki döndürür.
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
Gönderinin altında bulunan bir eklenti tarafından oluşturulan tüm ekleri döndürür.
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
Eklenti eklerini günceller.

REST Kaynağı: v1.courses.courseWork

Yöntemler
create POST /v1/courses/{courseId}/courseWork
Sınıf çalışmaları oluşturur.
delete DELETE /v1/courses/{courseId}/courseWork/{id}
Ders çalışmasını siler.
get GET /v1/courses/{courseId}/courseWork/{id}
Kurs çalışmalarını döndürür.
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
İsteği gönderen kullanıcının görüntülemesine izin verilen kurs çalışmalarının listesini döndürür.
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
Atananlar modunu ve sınıf çalışmasının seçeneklerini değiştirir.
patch PATCH /v1/courses/{courseId}/courseWork/{id}
Bir 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ına 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}
Bir eklenti eki döndürür.
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
Gönderinin altında bulunan bir eklenti tarafından oluşturulan tüm ekleri döndürür.
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
Eklenti eklerini 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önderimiyle 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}
Bir 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
İsteği gönderen kullanıcının görüntülemesine izin verilen notlandırma sistemlerinin listesini döndürür.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
Puan anahtarını günceller.

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

Yöntemler
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Öğrencinin gönderimini döndürür.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
İsteğin OAuth kapsamlarını dikkate alarak, istek sahibinin görüntülemesine izin verilen öğrenci gönderimlerinin listesini döndürür.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Öğrenci gönderimlerinin eklerini değiştirir.
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Bir öğrenci gönderimindeki bir veya daha fazla alanı günceller.
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
Bir öğrenci gönderimini, gönderimin sahibi olan öğrenci adına yeniden alır.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Öğrencinin gönderimini döndürür.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Öğrencinin gönderdiği dosyayı 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}
Ders çalışma materyalini siler.
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
Bir ders ç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
İsteği gönderen kullanıcının görüntülemesine izin verilen kurs çalışması materyallerinin listesini döndürür.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Sınıf çalışması materyalindeki bir veya daha fazla alanı günceller.

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

Yöntemler
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Bir yayının altına 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}
Bir eklenti eki döndürür.
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
Gönderinin altında bulunan bir eklenti tarafından oluşturulan tüm ekleri döndürür.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
Eklenti eklerini 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}
Bir eklenti eki döndürür.
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
Bir eklenti tarafından oluşturulan tüm ekleri yayının altına döndürür.
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
Eklenti eklerini 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önderimiyle ilişkili verileri günceller.

REST Kaynağı: v1.courses.students

Yöntemler
create POST /v1/courses/{courseId}/students
Bir kullanıcıyı bir dersin öğrencisi olarak ekler.
delete DELETE /v1/courses/{courseId}/students/{userId}
Bir öğrenciyi kurstan siler.
get GET /v1/courses/{courseId}/students/{userId}
Bir dersin öğrencisini döndürür.
list GET /v1/courses/{courseId}/students
Bu kurstaki, istek sahibinin görüntüleme iznine sahip olduğu öğrencilerin listesini döndürür.

REST Kaynağı: v1.courses.teachers

Yöntemler
create POST /v1/courses/{courseId}/teachers
Bir kurs için öğretmen oluşturur.
delete DELETE /v1/courses/{courseId}/teachers/{userId}
Belirtilen öğretmeni belirtilen dersten kaldırır.
get GET /v1/courses/{courseId}/teachers/{userId}
Bir dersin öğretmenini döndürür.
list GET /v1/courses/{courseId}/teachers
İsteği gönderen kullanıcının görüntülemesine izin verilen bu dersin öğretmenlerinin 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}
Bir konuyu siler.
get GET /v1/courses/{courseId}/topics/{id}
Bir konu döndürür.
list GET /v1/courses/{courseId}/topics
İstekte bulunanın 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, davetiyeyi kaldırır ve davet edilen kullanıcıyı belirtilen dersin öğretmenlerine 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 davetlerin listesini döndürür. Bu liste, liste isteğiyle eşleşenlerle sınırlıdır.

REST Kaynağı: v1.registrations

Yöntemler
create POST /v1/registrations
Classroom'un, sağlanan feed adresinden cloudPubSubTopic adresine bildirim göndermeye başlamasına neden olan bir Registration oluşturur.
delete DELETE /v1/registrations/{registrationId}
Bir Registration silindiğinde Classroom bu Registration için bildirim göndermeyi durdurur.

REST Kaynağı: v1.userProfiles

Yöntemler
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
Kullanıcının belirtilen Classroom özelliğini kullanıp kullanamayacağını döndürür.
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
Veli davetiyesi oluşturur ve veliye, öğrencinin velisi olduklarını onaylamasını isteyen bir e-posta gönderir.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Belirli bir veli davetiyesini döndürür.
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 filtrelenen 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}
Bir veliyi siler.
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
Belirli bir veliyi döndürür.
list GET /v1/userProfiles/{studentId}/guardians
İstekte bulunan kullanıcının görüntülemesine izin verilen veli listesini döndürür. Liste, istekle eşleşenlerle kısıtlanır.