Method: courses.announcements.list

Gibt eine Liste der Ankündigungen zurück, die der Anforderer sehen darf.

Schüler und Studenten können Ankündigungen zu PUBLISHED nur sehen. Lehrkräfte und Domainadministratoren können sich alle Ankündigungen ansehen.

Diese Methode gibt die folgenden Fehlercodes zurück:

  • PERMISSION_DENIED, wenn der anfragende Nutzer nicht berechtigt ist, auf den angeforderten Kurs zuzugreifen, oder wenn Zugriffsfehler vorliegen.
  • INVALID_ARGUMENT, wenn die Anfrage fehlerhaft ist.
  • NOT_FOUND, wenn der angeforderte Kurs nicht vorhanden ist.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
courseId

string

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

Abfrageparameter

Parameter
announcementStates[]

enum (AnnouncementState)

Beschränkung für die 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 Schlüsselwort für die Sortierrichtung. Unterstütztes Feld ist updateTime. Unterstützte Richtungs-Keywords sind asc und desc. Wenn nicht angegeben, ist updateTime desc das Standardverhalten. Beispiele: updateTime asc, updateTime
pageSize

integer

Maximale Anzahl der Elemente, die zurückgegeben werden sollen. Null oder nicht angegeben bedeutet, dass der Server einen Höchstwert 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. Dieser Wert gibt an, dass die nachfolgende 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 der Anfrage entsprechen.
nextPageToken

string

Token, das die nächste Ergebnisseite identifiziert, die zurückgegeben werden soll. Wenn das Feld leer ist, 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.