Method: courses.studentGroups.list

Zwraca listę grup na kursie.

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

  • NOT_FOUND, jeśli kurs nie istnieje.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
courseId

string

Wymagany. Identyfikator kursu.

Parametry zapytania

Parametry
pageSize

integer

Maksymalna liczba elementów do zwrócenia. Wartość 0 lub brak wartości oznacza, że serwer może przypisać maksymalną liczbę elementów, która obecnie wynosi 75.

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 wyników.

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

enum (PreviewVersion)

Opcjonalnie. Wersja przedpremierowa interfejsu API. Musisz ustawić tę wartość, aby uzyskać dostęp do nowych funkcji interfejsu API udostępnionych deweloperom w ramach programu podglądu.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania listy grup uczniów.

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

Zapis JSON 
{
  "studentGroups": [
    {
      object (StudentGroup)
    }
  ],
  "nextPageToken": string
}
Pola
studentGroups[]

object (StudentGroup)

Grupy uczniów.
nextPageToken

string

Token identyfikujący następną stronę wyników do zwrócenia. Jeśli jest puste, nie ma więcej 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

Więcej informacji znajdziesz w przewodniku po autoryzacji.