Method: courses.students.list

İsteği gönderen kullanıcının görüntülemesine izin verilen, bu kurstaki öğ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

Dersin tanımlayıcısıdır. 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ı. Belirtilmemişse veya 0 ise varsayılan değer 30'dur.

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

string

Önceki bir list çağrısından döndürülen nextPageToken değeri. Sonuçların sonraki sayfasının döndürülmesi gerektiğini belirtir.

list isteği, bu jetonla sonuçlanan istekte belirtilenlerle aynı olmalıdır.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Öğrenciler listelenirken gösterilen 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şsa başka sonuç yoktur.

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 bakın.