Method: courses.courseWorkMaterials.list

Zwraca listę materiałów szkoleniowych, które osoba zgłaszająca prośbę może przeglądać.

Uczniowie mogą wyświetlać tylko PUBLISHED materiałów do wykonania. Nauczyciele i administratorzy domeny mogą wyświetlać wszystkie materiały szkoleniowe.

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

  • PERMISSION_DENIED, jeśli użytkownik wysyłający prośbę nie ma dostępu do żądanego szkolenia lub w przypadku błędów dostępu.
  • INVALID_ARGUMENT, jeśli żądanie jest uszkodzone.
  • NOT_FOUND, jeśli żądane szkolenie nie istnieje.

Żądanie HTTP

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials

Adres URL używa składni transkodowania gRPC.

Parametry ścieżki

Parametry
courseId

string

Identyfikator zajęć. Może to być identyfikator przypisany do Classroom lub alias.

Parametry zapytania

Parametry
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

Ograniczenie dotyczące statusu zadania do zwrócenia. Zwracane są tylko pasujące materiały szkoleniowe. Jeśli nie określono inaczej, zwracane są elementy ze stanem „Praca” PUBLISHED.

orderBy

string

Opcjonalne sortowanie wyników. Rozdzielona przecinkami lista pól z opcjonalnym słowem kluczowym dotyczącym kierunku sortowania. Obsługiwane pole to updateTime. Obsługiwane słowa kluczowe związane z kierunkiem to asc i desc. Jeśli nie określono tego ustawienia, domyślne zachowanie to updateTime desc. Przykłady: updateTime asc, updateTime

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.

materialDriveId

string

Opcjonalne filtrowanie materiałów szkoleniowych z co najmniej jednym materiałem z Dysku, którego identyfikator pasuje do podanego ciągu znaków. Jeśli określono także materialLink, materiały szkoleniowe muszą zawierać materiały pasujące do obu filtrów.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania listy materiałów do kursu.

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

Zapis JSON
{
  "courseWorkMaterial": [
    {
      object (CourseWorkMaterial)
    }
  ],
  "nextPageToken": string
}
Pola
courseWorkMaterial[]

object (CourseWorkMaterial)

Elementy materiałów szkoleniowych kursu, które pasują do żądania.

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.courseworkmaterials
  • https://www.googleapis.com/auth/classroom.courseworkmaterials.readonly

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.