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 nie istnieją użytkownicy określeni 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 zwracane kursy do tych, na których jest uczeń o podanym identyfikatorze. Identyfikator może być jednym z tych elementów:

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

Jeśli podano wartość, pole teacherId musi być puste.
teacherId

string

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

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

Jeśli podano wartość, pole studentId musi być puste.
courseStates[]

enum (CourseState)

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

integer

Maksymalna liczba elementó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 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 to ustawić, aby uzyskać dostęp do nowych funkcji interfejsu API udostępnionych deweloperom w ramach Programu testowania aktualizacji.

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 odpowiadające żądaniu listy.
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.courses
  • https://www.googleapis.com/auth/classroom.courses.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.