Method: courses.students.list

Bu dersteki, istekte bulunan kişinin görüntülemesine izin verilen öğ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 bir tanımlayıcı veya bir alias olabilir.

Sorgu parametreleri

Parametreler
pageSize

integer

İade edilecek maksimum öğe sayısı. Belirtilmemişse varsayılan değer 30'dur veya 0'dir.

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, sonraki sonuç sayfasının döndürülmesi gerektiğini belirtir.

Aksi takdirde, list isteği, bu jetonu sağlayan istekle aynı olmalıdır.

İstek içeriği

İstek metni boş olmalıdır.

Yanıt gövdesi

Öğrenciler listelenirken 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 sonuçların sonraki sayfasını tanımlayan jeton. Boşsa başka sonuç sunulmaz.

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ılavuzunu inceleyin.