Method: courses.students.list

Zwraca listę uczniów biorących udział w zajęciach, do których osoba wysyłająca prośbę może wyświetlać.

Ta metoda zwraca następujące kody błędów:

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
courseId

string

Identyfikator zajęć. Może to być identyfikator przypisany przez Classroom lub alias.

Parametry zapytania

Parametry
pageSize

integer

Maksymalna liczba produktów do zwrócenia. Jeśli wartość nie jest określona, wartość domyślna to 30 lub 0.

Serwer może zwrócić mniej wyników niż określono.
pageToken

string

Wartość nextPageToken zwrócona z poprzedniego wywołania list, która wskazuje, że powinna zostać zwrócona kolejna strona z wynikami.

Żądanie list musi być w inny sposób identyczne z żądaniem, które spowodowało ten token.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na listę uczniów.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "students": [
    {
      object (Student)
    }
  ],
  "nextPageToken": string
}
Pola
students[]

object (Student)

Uczniowie pasujący do prośby o listę.
nextPageToken

string

Token określający następną stronę wyników do zwrócenia. Jeśli pole jest puste, kolejne wyniki nie są dostępne.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • 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

Więcej informacji znajdziesz w przewodniku po autoryzacji.