Method: courses.list

Zwraca listę kursów, które użytkownik wysyłający żądanie może wyświetlić, ograniczoną do tych, które pasują do żądania. Zwrócone kursy są uporządkowane według czasu utworzenia, przy czym najnowsze są wyświetlane jako pierwsze.

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

  • PERMISSION_DENIED w przypadku błędów dostępu.
  • INVALID_ARGUMENT, jeśli argument zapytania jest nieprawidłowy.
  • NOT_FOUND, jeśli któryś z użytkowników określonych w argumentach zapytania nie istnieje.

Żądanie HTTP

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

Adres URL używa składni transkodowania gRPC.

Parametry zapytania

Parametry
studentId

string

Ogranicza zwracane kursy do tych, które mają ucznia o podanym identyfikatorze. Identyfikator może być jednym z tych elementów:

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

Jeśli podano ten parametr, parametr teacherId musi być pusty.
teacherId

string

Ogranicza zwracane kursy do tych, które mają nauczyciela o podanym identyfikatorze. Identyfikator może być jednym z tych elementów:

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

Jeśli podano ten parametr, parametr studentId musi być pusty.
courseStates[]

enum (CourseState)

Ogranicza zwracane kursy do tych, które są w jednym z określonych stanów. Jeśli nie podano tego parametru, zwracane są kursy w dowolnym stanie.
pageSize

integer

Maksymalna liczba elementów do zwrócenia. Zero lub brak wartości 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 przez poprzednie wywołanie list, która wskazuje, ż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 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)

Kursy pasujące do żądania listy.
nextPageToken

string

Token identyfikujący następną stronę wyników do zwrócenia. Jeśli jest pusty, nie ma więcej wyników.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/classroom.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.