Method: courses.students.list

Zwraca listę uczestników zajęć, które osoba zgłaszająca prośbę może wyświetlić.

Ta metoda zwraca te 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 do Classroom lub alias.

Parametry zapytania

Parametry
pageSize

integer

Maksymalna liczba produktów do zwrotu. Wartość domyślna to 30, jeśli wartość nie jest określona, lub 0.

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

string

Wartość nextPageToken zwrócona z poprzedniego wywołania list, co oznacza, że powinna zostać zwrócona kolejna strona wyników.

Żądanie list musi być identyczne z żądaniem, 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 pasujący do żądania listy.
nextPageToken

string

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

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu 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 na temat autoryzacji.