Method: courses.courseWorkMaterials.list

Zwraca listę materiałów do zajęć, które może wyświetlić osoba wysyłająca żądanie.

Uczniowie mogą wyświetlać tylko materiały do zajęć w stanie PUBLISHED. Nauczyciele i administratorzy domeny mogą wyświetlać wszystkie materiały do zajęć.

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

  • PERMISSION_DENIED, jeśli użytkownik wysyłający żądanie nie ma uprawnień dostępu do żądanych zajęć lub jeśli wystąpią błędy dostępu.
  • INVALID_ARGUMENT, jeśli żądanie jest błędnie sformatowane.
  • NOT_FOUND, jeśli żądane zajęcia nie istnieją.

Żą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 przez Classroom lub alias.

Parametry zapytania

Parametry
courseWorkMaterialStates[]

enum (CourseWorkMaterialState)

Ograniczenie dotyczące stanu zadania, które ma zostać zwrócone. Zwracane są tylko materiały do zajęć, które pasują do tego ograniczenia. Jeśli nie podasz żadnej wartości, zwracane są elementy ze stanem zadania PUBLISHED.
orderBy

string

Opcjonalne sortowanie wyników. Lista pól oddzielonych przecinkami z opcjonalnym słowem kluczowym określającym kierunek sortowania. Obsługiwane pole to updateTime. Obsługiwane słowa kluczowe określające kierunek to asc i desc. Jeśli nie podasz żadnej wartości, domyślnie używane jest ustawienie updateTime desc. Przykłady: updateTime asc, updateTime
pageSize

integer

Maksymalna liczba elementów do zwrócenia. Zero lub brak wartości 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 przez poprzednie wywołanie list, która wskazuje, że należy zwrócić następną stronę wyników.

Żądanie list musi być identyczne z żądaniem, które spowodowało wygenerowanie tego tokena.
materialDriveId

string

Opcjonalne filtrowanie materiałów do zajęć, które zawierają co najmniej 1 materiał z Dysku, którego identyfikator pasuje do podanego ciągu znaków. Jeśli podasz też materialLink, materiały do zajęć muszą pasować do obu filtrów.
previewVersion

enum (PreviewVersion)

Opcjonalnie. Wersja testowa interfejsu API. Aby uzyskać dostęp do nowych funkcji interfejsu API udostępnionych deweloperom w ramach Programu testowania aktualizacji, musisz ustawić tę wartość.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania listy materiałów do zajęć.

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

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

object (CourseWorkMaterial)

Materiały do zajęć pasujące do żądania.
nextPageToken

string

Token identyfikujący następną stronę wyników do zwrócenia. Jeśli jest pusty, nie ma więcej 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 po autoryzacji.