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 isteğinde bulunurken aşağıdaki bilgileri kullanın.

Keşif belgesi

Discovery Dokümanı, REST API'lerini açıklamak ve kullanmak için makine tarafından okunabilir bir spesifikasyondur. İstemci kitaplıkları, IDE eklentileri ve Google API'leri ile etkileşim kuran diğer araçları geliştirmek 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 temel URL'dir. Bir hizmetin birden fazla hizmet uç noktası olabilir. Bu hizmet aşağıdaki hizmet uç noktasına sahip ve aşağıdaki tüm URI'ler bu hizmet uç noktasına göre belirlenir:

  • https://classroom.googleapis.com

REST Kaynağı: v1.courses

Yöntemler
create POST /v1/courses
Bir ders oluşturur.
delete DELETE /v1/courses/{id}
Bir dersi siler.
get GET /v1/courses/{id}
Bir kurs döndürür.
list GET /v1/courses
İstekte bulunan kullanıcının, izin verdiği isteklerle sınırlı olan derslerin listesini gösterir.
patch PATCH /v1/courses/{id}
Bir kurstaki bir veya daha fazla alanı günceller.
update PUT /v1/courses/{id}
Bir dersi günceller.

REST Kaynağı: v1.courses.aliases

Yöntemler
create POST /v1/courses/{courseId}/aliases
Bir ders için bir takma ad oluşturur.
delete DELETE /v1/courses/{courseId}/aliases/{alias}
Dersin takma adını siler.
list GET /v1/courses/{courseId}/aliases
Bir kurs için takma ad listesi 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.
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 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.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}
Kurs çalışmasını döndürür.
list GET /v1/courses/{courseId}/courseWork
Talep eden 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
Atanan modu 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ındaki bir veya daha fazla alanı günceller.

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

Yöntemler
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
Öğrenci gönderimini döndürür.
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
İstekte bulunan kişinin görüntüleme iznine sahip olduğu öğrenci gönderimlerinin listesini döndürür ve isteğin OAuth kapsamlarını hesaba katar.
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
Öğrenci gönderim eklerini değiştirir.
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
Bir öğrenci gönderimi, sahibi olan öğrenci adına geri alınır.
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
Öğrenci gönderimini döndürür.
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
Öğrenci gönderimini sağlar.

REST Kaynağı: v1.courses.courseWorkMaterials

Yöntemler
create POST /v1/courses/{courseId}/courseWorkMaterials
Bir 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ı materyali döndürür.
list GET /v1/courses/{courseId}/courseWorkMaterials
Talep eden kişinin görüntülemesine izin verilen sınıf çalışması materyalinin listesini döndürür.
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
Bir sınıf çalışması materyalinin bir veya daha fazla alanını günceller.

REST Kaynağı: v1.courses.students

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

REST Kaynağı: v1.courses.teachers

Yöntemler
create POST /v1/courses/{courseId}/teachers
Bir 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}
Bir dersin öğretmenini döndürür.
list GET /v1/courses/{courseId}/teachers
Bu kursta istekte bulunan kişinin görüntülemesine izin verilen öğretmenlerin listesini döndürür.

REST Kaynağı: v1.courses.topics

Yöntemler
create POST /v1/courses/{courseId}/topics
Bir 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
Daveti kabul eder, daveti kaldırır ve davet edilen kullanıcıyı belirtilen kurstaki öğretmenlere veya öğrencilere (uygun olduğu şekilde) ekler.
create POST /v1/invitations
Davetiye oluşturur.
delete DELETE /v1/invitations/{id}
Davetiyeyi siler.
get GET /v1/invitations/{id}
Davetiye döndürür.
list GET /v1/invitations
İstekte bulunan kullanıcının görüntüleme iznine sahip olduğu ve liste isteğiyle eşleşen davetiyelerin listesini döndürür.

REST Kaynağı: v1.registrations

Yöntemler
create POST /v1/registrations
Bir Registration oluşturulur. Bu sayede Classroom, sağlanan feed kaynağından cloudPubSubTopic alanında sağlanan hedefe bildirim göndermeye başlar.
delete DELETE /v1/registrations/{registrationId}
Bir Registration silindiğinde, Classroom'un bu Registration için bildirim göndermeyi durdurmasına neden olur.

REST Kaynağı: v1.userProfiles

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

REST Kaynağı: v1.userProfiles.guardianInvites

Yöntemler
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
Bir veli daveti oluşturur ve veliye öğrencinin velisi olduğunu onaylaması için bir e-posta gönderir.
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Belirli bir veli davetiyesi döndürür.
list GET /v1/userProfiles/{studentId}/guardianInvitations
İstekte bulunan kullanıcının izin verdiği ve sağlanan parametrelerle filtrelenen veli davetiyelerinin listesini döndürür.
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
Veli davetiyesini değiştirir.

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üleme iznine sahip olduğu ve taleple eşleşen velilerle sınırlı bir veli listesi döndürür.