REST Resource: registrations

Ressource: Registrierung

Eine Anweisung an Classroom, Benachrichtigungen vom 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 Benachrichtigungsklasse, die Classroom an das Ziel senden soll.
expiryTime

string (Timestamp format)

Der Zeitraum, bis zu dem das Registration gültig ist.

Dieses Feld ist schreibgeschützt und wird vom Server zugewiesen.

Ein Zeitstempel im Format RFC3339 UTC "Zulu" mit einer Auflösung im Nanosekundenbereich und bis zu neun Nachkommastellen. Beispiele: "2014-10-02T15:01:23Z" und "2014-10-02T15:01:23.045123456Z".
Union-Feld destination. An wen 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 Benachrichtigungsklasse, die eine Anwendung zum Empfang registrieren kann. Beispiel: „alle Kaderä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 Feedtyp.
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 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 COURSE_WORK_CHANGES ist.

FeedType

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

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

Alle Änderungen am Gruppenverzeichnis für eine bestimmte Domain.

Es werden Benachrichtigungen 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 jedoch eine Einladung annimmt und einem Kurs beitritt, werden Benachrichtigungen generiert.
COURSE_ROSTER_CHANGES

Alle Änderungen am Teilnehmerverzeichnis für einen bestimmten Kurs.

Es werden Benachrichtigungen 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 jedoch eine Einladung annimmt und einem Kurs beitritt, werden Benachrichtigungen generiert.
COURSE_WORK_CHANGES

Alle Kursaktivitäten für einen bestimmten Kurs.

Benachrichtigungen werden generiert, wenn ein Kurs- oder Schüler-/Studentenmitarbeitsobjekt erstellt oder geändert wird. Es wird keine Benachrichtigung generiert, wenn ein StudentSubmission-Objekt im Zusammenhang mit der Erstellung oder Änderung des übergeordneten Kursobjekts erstellt wird. Es wird jedoch eine Benachrichtigung für die Erstellung oder Änderung dieses Kursobjekts 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 am Teilnehmerverzeichnis 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 Benachrichtigungen zu Arbeitsänderungen abonnieren möchten.

CloudPubsubTopic

Ein Verweis auf ein Cloud Pub/Sub-Thema.

Damit Sie sich für Benachrichtigungen registrieren können, 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, wodurch Classroom Benachrichtigungen von der angegebenen feed an das in cloudPubSubTopic angegebene Ziel sendet.

delete

 Wenn Sie eine Registration löschen, werden in Classroom keine Benachrichtigungen mehr für diese Registration gesendet.