REST Resource: registrations

Ressource: Registrierung

Eine Anleitung an Classroom, mit der Benachrichtigungen von feed an das angegebene Ziel gesendet werden.

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 Klasse von Benachrichtigungen, die Classroom an das Ziel senden soll.
expiryTime

string (Timestamp format)

Die Zeit, bis zu der Registration gilt.

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

Ein Zeitstempel im Format RFC3339 UTC „Zulu“ mit Nanosekundenauflösung und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
Union-Feld destination. Empfänger von Benachrichtigungen 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, die eine Anwendung für den Empfang registrieren kann. Beispiel: „alle Teilnehmerlistenänderungen 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)

Der Typ 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 den Wert COURSE_ROSTER_CHANGES hat.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informationen zu einem Feed mit einem feedType von COURSE_WORK_CHANGES. Dieses Feld muss angegeben werden, wenn feedType den Wert COURSE_WORK_CHANGES hat.

FeedType

Ein Feedtyp, von dem eine Anwendung für Benachrichtigungen registriert werden kann.

Enums
FEED_TYPE_UNSPECIFIED Sollte nie zurückgegeben oder zur Verfügung gestellt werden.
DOMAIN_ROSTER_CHANGES

Alle Teilnehmerlistenänderungen 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 mehr generiert. Wenn ein Nutzer jedoch einem Kurs beitritt, indem er eine Einladung annimmt.
COURSE_ROSTER_CHANGES

Alle Änderungen 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 mehr generiert. Wenn ein Nutzer jedoch einem Kurs beitritt, indem er eine Einladung annimmt.
COURSE_WORK_CHANGES

Alle Kursaktivitäten für einen bestimmten Kurs.

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

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 die Sie Teilnehmerlistenänderungen abonnieren möchten.

CourseWorkChangesInfo

Informationen zu einem Feed mit einem feedType von COURSE_WORK_CHANGES.

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

string

Der courseId des Kurses, für den Sie arbeitsbezogene Änderungen abonnieren möchten.

CloudPubsubTopic

Ein Verweis auf ein Cloud Pub/Sub-Thema.

Zur Registrierung für Benachrichtigungen muss der Inhaber des Themas classroom-notifications@system.gserviceaccount.com die Berechtigung projects.topics.publish erteilen.

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

string

Das Feld name eines Cloud Pub/Sub-Themas.

Methoden

create

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

delete

 Löscht ein Registration, sodass Classroom keine Benachrichtigungen mehr für diesen Registration sendet.