Method: courses.students.list

İstek sahibinin görüntüleme iznine sahip olduğu bu dersteki öğrencilerin listesini döndürür.

Bu yöntem aşağıdaki hata kodlarını döndürür:

HTTP isteği

GET https://classroom.googleapis.com/v1/courses/{courseId}/students

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
courseId

string

Kursun tanımlayıcısı. Bu tanımlayıcı, Classroom tarafından atanan tanımlayıcı veya bir alias olabilir.

Sorgu parametreleri

Parametreler
pageSize

integer

Döndürülecek maksimum öğe sayısı. Belirtilmediyse varsayılan değer 30 veya 0'dir.

Sunucu, belirtilen sayıdan daha az sonuç döndürebilir.

pageToken

string

nextPageToken değeri, sonraki sonuç sayfasının döndürülmesi gerektiğini belirten önceki bir list çağrısından döndürüldü.

list isteği, aksi takdirde bu jetonla sonuçlanan istekle aynı olmalıdır.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Öğrencileri listelerken verilen yanıt.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
Alanlar
students[]

object (Student)

Liste isteğiyle eşleşen öğrenciler.

nextPageToken

string

Döndürülecek bir sonraki sonuç sayfasını tanımlayan jeton. Boş bırakılırsa başka sonuç yok.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

  • https://www.googleapis.com/auth/classroom.rosters
  • https://www.googleapis.com/auth/classroom.rosters.readonly
  • https://www.googleapis.com/auth/classroom.profile.emails
  • https://www.googleapis.com/auth/classroom.profile.photos

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