- Ressource: Registrierung
- Feed
- FeedType
- CourseRosterChangesInfo
- CourseWorkChangesInfo
- CloudPubsubTopic
- Methoden
Ressource: Registrierung
Eine Anleitung an Classroom, mit der Benachrichtigungen von feed
an das angegebene Ziel gesendet werden.
JSON-Darstellung |
---|
{ "registrationId": string, "feed": { object ( |
Felder | |
---|---|
registrationId |
Eine vom Server generierte, eindeutige Kennung für diese Schreibgeschützt. |
feed |
Spezifikation für die Klasse von Benachrichtigungen, die Classroom an das Ziel senden soll. |
expiryTime |
Die Zeit, bis zu der 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: |
Union-Feld destination . Empfänger von Benachrichtigungen Für destination ist nur einer der folgenden Werte zulässig: |
|
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 ( |
Felder | |
---|---|
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 |
Informationen zu einem |
courseWorkChangesInfo |
Informationen zu einem |
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 |
Die |
CourseWorkChangesInfo
Informationen zu einem Feed
mit einem feedType
von COURSE_WORK_CHANGES
.
JSON-Darstellung |
---|
{ "courseId": string } |
Felder | |
---|---|
courseId |
Der |
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 |
Das Feld |
Methoden |
|
---|---|
|
Erstellt eine Registration . Dadurch sendet Classroom Benachrichtigungen von der angegebenen feed an das in cloudPubSubTopic angegebene Ziel. |
|
Löscht ein Registration , sodass Classroom keine Benachrichtigungen mehr für diesen Registration sendet. |