REST Resource: registrations

Ressource: Registrierung

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

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

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
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)

Der Zeitpunkt, bis zu dem die Registration gültig 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".
Wohin Benachrichtigungen gesendet werden sollen. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
cloudPubsubTopic

object (CloudPubsubTopic)

Das Cloud Pub/Sub-Thema, an das Benachrichtigungen gesendet werden sollen.
Ende der sich gegenseitig ausschließenden Felder.

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),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
Felder
feedType

enum (FeedType)

Der Typ des Feeds.
Zusätzliche Parameter zum Feed. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
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.
Ende der sich gegenseitig ausschließenden Felder.

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 generiert, wenn ein Nutzer einem Kurs beitritt oder ihn verlässt.

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

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

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

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

Alle Kursaktivitäten 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. Es wird jedoch eine Benachrichtigung für die Erstellung oder Änderung dieses CourseWork-Objekts 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 Änderungen an der Teilnehmerliste abonniert werden sollen.

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 Änderungen an Aufgaben abonniert werden sollen.

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 ein Registration, wodurch Classroom Benachrichtigungen von der angegebenen feed an das in cloudPubSubTopic angegebene Ziel sendet.

delete

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