Method: courses.announcements.list

Gibt eine Liste mit Mitteilungen zurück, die der Antragsteller ansehen darf.

Kursteilnehmer können sich nur PUBLISHED Ankündigungen ansehen. Lehrkräfte und Domainadministratoren können alle Mitteilungen sehen.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der anfragende Nutzer keinen Zugriff auf den angeforderten Kurs hat, oder bei Zugriffsfehlern.
  • INVALID_ARGUMENT, wenn die Anfrage fehlerhaft ist.
  • NOT_FOUND, wenn der angeforderte Kurs nicht existiert.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

Kennung des Kurses. Diese Kennung kann entweder die in Classroom zugewiesene Kennung oder eine alias sein.

Abfrageparameter

Parameter
announcementStates[]

enum (AnnouncementState)

Einschränkung der state der zurückgegebenen Ankündigungen. Wird dieses Argument nicht angegeben, ist der Standardwert PUBLISHED.
orderBy

string

Optionale Sortierreihenfolge für Ergebnisse. Eine durch Kommas getrennte Liste von Feldern mit einem optionalen Keyword für die Sortierrichtung. Unterstütztes Feld: updateTime. Unterstützte Richtungs-Keywords sind asc und desc. Wenn keine Angabe erfolgt, ist updateTime desc das Standardverhalten. Beispiele: updateTime asc, updateTime
pageSize

integer

Die maximale Anzahl der Elemente, die zurückgegeben werden sollen. „0“ oder „nicht angegeben“ bedeutet, dass der Server ein Maximum zuweisen kann.

Der Server gibt möglicherweise weniger als die angegebene Anzahl von Ergebnissen zurück.
pageToken

string

nextPageToken-Wert, der von einem vorherigen list-Aufruf zurückgegeben wurde und angibt, dass die nächste Ergebnisseite zurückgegeben werden soll.

Die list-Anfrage muss ansonsten mit der Anfrage identisch sein, die zu diesem Token geführt hat.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Antwort beim Auflisten von Kursarbeiten.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
Felder
announcements[]

object (Announcement)

Ankündigungselemente, die mit der Anfrage übereinstimmen.
nextPageToken

string

Token, das die nächste Ergebnisseite identifiziert, die zurückgegeben werden soll. Ist das Feld leer, sind keine weiteren Ergebnisse verfügbar.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie im Leitfaden zur Autorisierung.