REST Resource: registrations

Ressource: Registrierung

Eine Anleitung für Classroom, wie Benachrichtigungen von der 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 den Kurs der Benachrichtigungen, die Classroom an das Ziel senden soll.
expiryTime

string (Timestamp format)

Der Zeitpunkt, bis zu dem die Registration wirksam ist.

Dieses schreibgeschützte Feld 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 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 für den Feed. Für info ist nur einer der folgenden Werte zulässig:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informationen zu 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 Feed mit einem feedType von COURSE_WORK_CHANGES. Dieses Feld muss angegeben werden, wenn feedType den Wert COURSE_WORK_CHANGES hat.

FeedType

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

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

Alle Änderungen 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 eine Einladung annimmt und einem Kurs beitritt.
COURSE_ROSTER_CHANGES

Alle Teilnehmerlisten für einen bestimmten Kurs werden geändert.

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 eine Einladung annimmt und einem Kurs beitritt.
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 in Verbindung mit der Erstellung oder Änderung des übergeordneten CourseWork-Objekts erstellt wird. Es wird jedoch eine Benachrichtigung für die Erstellung oder Änderung dieses KursWork-Objekts generiert.

CourseRosterChangesInfo

Informationen zu Feed mit einem feedType von COURSE_ROSTER_CHANGES.

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

string

Die courseId des Kurses, für die Teilnehmerlistenänderungen abonniert werden sollen.

CourseWorkChangesInfo

Informationen zu Feed mit einem feedType von COURSE_WORK_CHANGES.

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

string

Die courseId des Kurses, für den Sie ein Abo abschließen möchten, ändern sich.

CloudPubsubTopic

Ein Verweis auf ein Cloud Pub/Sub-Thema.

Um sich für Benachrichtigungen zu registrieren, 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, wodurch Classroom beginnt, Benachrichtigungen von der angegebenen feed an das in cloudPubSubTopic angegebene Ziel zu senden.

delete

 Ein Registration wird gelöscht. Classroom sendet dann keine Benachrichtigungen mehr für diese Registration.