Method: courses.list

Zwraca listę zajęć, które użytkownik może wyświetlić, ograniczając ją do tych, które pasują do żądania. Zwracane kursy są uporządkowane według czasu utworzenia, przy czym na początku znajdują się kursy utworzone ostatnio.

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 ma żadnych użytkowników określonych 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, które mają studenta o określonym identyfikatorze. Identyfikator może być jednym z tych elementów:

  • identyfikator liczbowy użytkownika;
  • adres e-mail użytkownika.
  • ciąg znaków "me" wskazujący użytkownika, który wysłał żądanie;
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 liczbowy użytkownika;
  • adres e-mail użytkownika.
  • ciąg znaków "me" wskazujący użytkownika, który wysłał żądanie;
courseStates[]

enum (CourseState)

Ogranicza zwracane kursy do tych, które mają jeden z określonych stanów. Wartość domyślna to ACTIVE (aktywny), ARCHIVED (zarchiwizowany), PROVISIONED (zainicjowany) lub DECLINED (odrzucony).
pageSize

integer

Maksymalna liczba elementów do zwrócenia. Wartość 0 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, wskazująca, ż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, które odpowiadają żądaniu listy.
nextPageToken

string

Token identyfikujący następną stronę wyników do zwrócenia. Jeśli jest puste, nie ma dostępnych dalszych 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 dotyczącym autoryzacji.