Method: courses.courseWorkMaterials.list

Zwraca listę materiałów z zajęć, które może wyświetlić osoba przesyłająca prośbę.

Uczniowie mogą wyświetlać tylko materiały z zajęć PUBLISHED. Nauczyciele i administratorzy domen mogą wyświetlać wszystkie materiały z zajęć.

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

  • PERMISSION_DENIED jeśli użytkownik nie ma dostępu do kursu lub w przypadku błędów dostępu.
  • INVALID_ARGUMENT jeśli żądanie ma nieprawidłowy format.
  • NOT_FOUND, jeśli wybrany kurs 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 kursu. Identyfikatorem może być identyfikator przypisany przez Classroom lub alias.

Parametry zapytania

Parametry
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

Ograniczenie dotyczące stanu zadania, które ma zostać zwrócone. Zwracane są tylko pasujące materiały z zajęć. Jeśli nie podano tego argumentu, zwracane są elementy o stanie pracy PUBLISHED.

orderBy

string

Opcjonalne sortowanie wyników. Lista pól oddzielonych przecinkami z opcjonalnym słowem kluczowym kierunku sortowania. Obsługiwane pole to updateTime. Obsługiwane słowa kluczowe dotyczące kierunku to ascdesc. Jeśli nie podasz żadnej wartości, domyślnie zostanie użyta wartość updateTime desc. Przykłady: updateTime asc, updateTime

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.

materialDriveId

string

Opcjonalne filtrowanie materiałów z zajęć, które zawierają co najmniej 1 materiał z Dysku, którego identyfikator pasuje do podanego ciągu znaków. Jeśli podana jest też wartość materialLink, materiały z treści kursu muszą zawierać materiały pasujące do obu filtrów.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na pytanie o materiały do pracy domowej.

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łu z kursu, które pasują do żądania.

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

Więcej informacji znajdziesz w przewodniku dotyczącym autoryzacji.