Method: courses.list

Zwraca listę kursów, które może wyświetlać użytkownik wysyłający prośbę. Zwracana jest tylko lista kursów zgodnych z żądaniem. Zwrócone kursy są uporządkowane według czasu utworzenia – najnowsze znajdują się na początku.

Ta metoda zwraca następujące 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 żadni użytkownicy wymienieni w argumentach zapytania nie istnieją.

Żą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 znajduje się uczeń o określonym identyfikatorze. Może on mieć jeden z tych identyfikatorów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika.
  • literał ciągu znaków "me" wskazujący 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 on mieć jeden z tych identyfikatorów:

  • identyfikator numeryczny użytkownika
  • adres e-mail użytkownika.
  • literał ciągu znaków "me" wskazujący użytkownika wysyłającego żądanie
courseStates[]

enum (CourseState)

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

integer

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

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 z wynikami.

Żądanie list musi być w inny sposób identyczne z żądaniem, które spowodowało ten token.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na listę 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 określający następną stronę wyników do zwrócenia. Jeśli pole jest puste, kolejne wyniki nie są dostępne.

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.