Method: courses.list

Zwraca listę kursów, które może przeglądać użytkownik wysyłający prośbę, ograniczona do tych, które pasują do żądania. Zwrócone kursy są uporządkowane według czasu utworzenia (na początku wyświetlają się ostatnio utworzone).

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

  • PERMISSION_DENIED w przypadku błędów dostępu.
  • INVALID_ARGUMENT, jeśli argument zapytania ma nieprawidłowy format.
  • NOT_FOUND, jeśli nie istnieją użytkownicy wymienieni w argumentach zapytania.

Żądanie HTTP

GET https://classroom.googleapis.com/v1/courses

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
studentId

string

Ogranicza zwrócone zajęcia do tych, w których uczeń ma określony identyfikator. Może to być jeden z tych identyfikatorów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika,
  • literał ciągu "me", który wskazuje użytkownika wysyłającego żądanie
teacherId

string

Ogranicza zwrócone zajęcia do tych, które mają nauczyciela o określonym identyfikatorze. Może to być jeden z tych identyfikatorów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika,
  • literał ciągu "me", który wskazuje użytkownika wysyłającego żądanie
courseStates[]

enum (CourseState)

Ogranicza zwrócone kursy do tych znajdujących się w jednym z określonych stanów. Wartość domyślna to ACTIVE, ARCHIVED, PROVISIONED, DECLINED.
pageSize

integer

Maksymalna liczba produktów do zwrotu. Wartość 0 lub nieokreślona oznacza, że serwer może przypisać wartość maksymalną.

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ź przy wyświetlaniu listy kursów.

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

Zapis JSON 
{
  "courses": [
    {
      object (Course)
    }
  ],
  "nextPageToken": string
}
Pola
courses[]

object (Course)

Zajęcia pasujące do żądania wyświetlenia 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.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.