Method: courses.announcements.list

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

Uczniowie mogą wyświetlać tylko ogłoszenia PUBLISHED. Nauczyciele zajęć i administratorzy domeny mogą wyświetlać wszystkie ogłoszenia.

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

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

enum (AnnouncementState)

Ograniczenie liczby state powiadomień z ogłoszeniami zwracanych przez funkcję. Jeśli ten argument nie zostanie określony, domyślną wartością będzie 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 asc i desc. 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.

Treść żądania

Treść żądania musi być pusta.

Treść odpowiedzi

Odpowiedź na pytanie o zadania

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łoszenia pasujące 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.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

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