Method: courses.students.list

Zwraca listę uczniów tego kursu, których dane może wyświetlić osoba przesyłająca żądanie.

Ta metoda zwraca te kody błędów:

  • NOT_FOUND, jeśli kurs nie istnieje.
  • PERMISSION_DENIED w przypadku błędów dostępu.

Żą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 kursu. Identyfikatorem może być identyfikator przypisany przez Classroom lub alias.

Parametry zapytania

Parametry
pageSize

integer

Maksymalna liczba elementów do zwrócenia. Jeśli nie zostanie podana wartość, zostanie użyta wartość domyślna 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, wskazująca, że należy zwrócić kolejną stronę wyników.

Żądanie list musi być identyczne z tym, które spowodowało wygenerowanie tego tokena.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania listy 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, którzy pasują do żądania listy.
nextPageToken

string

Token identyfikujący następną stronę wyników do zwrócenia. Jeśli jest puste, nie ma dostępnych dalszych wyników.

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 dotyczącym autoryzacji.