Method: courses.announcements.list

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

Uczniowie mogą wyświetlać tylko ogłoszenia (PUBLISHED). Nauczyciele biorący udział w zajęciach i administratorzy domeny mogą wyświetlać wszystkie ogłoszenia.

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}/announcements

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

enum (AnnouncementState)

Zwrócono ograniczenie dotyczące state ogłoszeń. Jeśli ten argument nie zostanie określony, wartością domyślną jest 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.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź podczas wyświetlania listy zadań.

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, nie są dostępne żadne dalsze wyniki.

Zakresy autoryzacji

Wymaga jednego z tych zakresów protokołu OAuth:

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

Więcej informacji znajdziesz w przewodniku na temat autoryzacji.