Method: courses.announcements.list

Zwraca listę ogłoszeń, które osoba wysyłająca prośbę może wyświetlać.

Uczestnicy zajęć mogą wyświetlać tylko ogłoszenia w języku: PUBLISHED. Nauczyciele kursów i administratorzy domeny mogą wyświetlać wszystkie ogłoszenia.

Ta metoda zwraca następujące kody błędów:

  • PERMISSION_DENIED, jeśli użytkownik wysyłający prośbę nie ma dostępu do żądanego kursu lub występuje błąd dostępu.
  • INVALID_ARGUMENT, jeśli żądanie jest uszkodzone.
  • NOT_FOUND, jeśli żądany kurs nie istnieje.

Żądanie HTTP

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

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
announcementStates[]

enum (AnnouncementState)

Ograniczenie dotyczące zwróconych ogłoszeń (state). Jeśli ten argument pozostanie nieokreślony, domyślną wartością będzie PUBLISHED.
orderBy

string

Opcjonalna kolejność sortowania 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 to asc i desc. Jeśli nie podasz tu żadnej wartości, domyślną wartością będzie updateTime desc. Przykłady: updateTime asc, updateTime
pageSize

integer

Maksymalna liczba produktó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 z wynikami.

Żądanie list musi być w inny sposób identyczne z żądaniem, które spowodowało ten token.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na listę zadań na zajęciach.

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

Zapis JSON 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
Pola
announcements[]

object (Announcement)

Elementy ogłoszeń pasujące do żądania.
nextPageToken

string

Token określający następną stronę wyników do zwrócenia. Jeśli pole jest puste, kolejne wyniki nie są dostępne.

Zakresy autoryzacji

Wymaga jednego z tych zakresów OAuth:

  • https://www.googleapis.com/auth/classroom.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

Więcej informacji znajdziesz w przewodniku po autoryzacji.