REST Resource: registrations

Ressource: Registrierung

Eine Anweisung an Classroom, Benachrichtigungen aus dem feed an das angegebene Ziel zu senden.

JSON-Darstellung 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  // Union field destination can be only one of the following:
  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
  // End of list of possible types for union field destination.
}
Felder
registrationId

string

Eine vom Server generierte eindeutige Kennung für diese Registration.

Schreibgeschützt.
feed

object (Feed)

Spezifikation für die Art der Benachrichtigungen, die Classroom an das Ziel senden soll.
expiryTime

string (Timestamp format)

Die Zeit, bis zu der die Registration wirksam ist.

Dies ist ein schreibgeschütztes Feld, das vom Server zugewiesen wird.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
Union-Feld destination. Wohin Benachrichtigungen gesendet werden sollen. Für destination ist nur einer der folgenden Werte zulässig:
cloudPubsubTopic

object (CloudPubsubTopic)

Das Cloud Pub/Sub-Thema, an das Benachrichtigungen gesendet werden sollen.

Feed

Eine Klasse von Benachrichtigungen, für die sich eine Anwendung registrieren kann. Beispiel: „Alle Änderungen an der Teilnehmerliste für eine Domain“.

JSON-Darstellung 
{
  "feedType": enum (FeedType),

  // Union field info can be only one of the following:
  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
  // End of list of possible types for union field info.
}
Felder
feedType

enum (FeedType)

Die Art des Feeds.
Union-Feld info. Zusätzliche Parameter zum Feed. Für info ist nur einer der folgenden Werte zulässig:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informationen zu einem Feed mit einem feedType von COURSE_ROSTER_CHANGES. Dieses Feld muss angegeben werden, wenn feedType gleich COURSE_ROSTER_CHANGES ist.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informationen zu einem Feed mit einem feedType von COURSE_WORK_CHANGES. Dieses Feld muss angegeben werden, wenn feedType gleich COURSE_WORK_CHANGES ist.

FeedType

Ein Feedtyp, für den eine Anwendung Benachrichtigungen registrieren kann.

Enums
FEED_TYPE_UNSPECIFIED Sollte nie zurückgegeben oder angegeben werden.
DOMAIN_ROSTER_CHANGES

Alle Änderungen an der Teilnehmerliste für eine bestimmte Domain.

Benachrichtigungen werden immer dann generiert, wenn ein Nutzer einem Kurs beitritt oder ihn verlässt.

Wenn eine Einladung erstellt oder gelöscht wird, werden keine Benachrichtigungen generiert. Wenn ein Nutzer einem Kurs beitritt, indem er eine Einladung annimmt, werden jedoch Benachrichtigungen generiert.
COURSE_ROSTER_CHANGES

Alle Änderungen an der Teilnehmerliste für einen bestimmten Kurs.

Benachrichtigungen werden immer dann generiert, wenn ein Nutzer einem Kurs beitritt oder ihn verlässt.

Wenn eine Einladung erstellt oder gelöscht wird, werden keine Benachrichtigungen generiert. Wenn ein Nutzer einem Kurs beitritt, indem er eine Einladung annimmt, werden jedoch Benachrichtigungen generiert.
COURSE_WORK_CHANGES

Alle Kursarbeiten für einen bestimmten Kurs.

Benachrichtigungen werden generiert, wenn ein CourseWork- oder StudentSubmission-Objekt erstellt oder geändert wird. Es wird keine Benachrichtigung generiert, wenn ein StudentSubmission-Objekt im Zusammenhang mit der Erstellung oder Änderung des übergeordneten CourseWork-Objekts erstellt wird. Für die Erstellung oder Änderung des CourseWork-Objekts wird jedoch eine Benachrichtigung generiert.

CourseRosterChangesInfo

Informationen zu einem Feed mit einem feedType von COURSE_ROSTER_CHANGES.

JSON-Darstellung 
{
  "courseId": string
}
Felder
courseId

string

Die courseId des Kurses, für den Sie Änderungen an der Teilnehmerliste abonnieren möchten.

CourseWorkChangesInfo

Informationen zu einem Feed mit einem feedType von COURSE_WORK_CHANGES.

JSON-Darstellung 
{
  "courseId": string
}
Felder
courseId

string

Die courseId des Kurses, für den Sie Änderungen an Aufgaben abonnieren möchten.

CloudPubsubTopic

Eine Referenz auf ein Cloud Pub/Sub-Thema.

Damit sich classroom-notifications@system.gserviceaccount.com für Benachrichtigungen registrieren kann, muss der Inhaber des Themas classroom-notifications@system.gserviceaccount.com die Berechtigung projects.topics.publish gewähren.

JSON-Darstellung 
{
  "topicName": string
}
Felder
topicName

string

Das Feld name eines Cloud Pub/Sub-Themas.

Methoden

create

 Erstellt eine Registration, sodass Classroom Benachrichtigungen von der angegebenen feed an das in cloudPubSubTopic angegebene Ziel sendet.

delete

 Löscht ein Registration. In Classroom werden dann keine Benachrichtigungen mehr für dieses Registration gesendet.