REST Resource: registrations

Risorsa: Registration

Un'istruzione per Classroom di inviare notifiche da feed alla destinazione fornita.

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

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
Campi
registrationId

string

Un identificatore univoco generato dal server per questo Registration.

Sola lettura.
feed

object (Feed)

Specifica della classe di notifiche che Classroom deve inviare alla destinazione.
expiryTime

string (Timestamp format)

L'ora fino alla quale Registration è in vigore.

Questo è un campo di sola lettura assegnato dal server.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
Dove devono essere inviate le notifiche. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
cloudPubsubTopic

object (CloudPubsubTopic)

L'argomento Cloud Pub/Sub a cui inviare le notifiche.
Fine dei campi che si escludono a vicenda.

Feed

Una classe di notifiche che un'applicazione può registrarsi per ricevere. Ad esempio: "tutte le modifiche al roster per un dominio".

Rappresentazione JSON 
{
  "feedType": enum (FeedType),

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

enum (FeedType)

Il tipo di feed.
Parametri aggiuntivi relativi al feed. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informazioni su un Feed con un feedType di COURSE_ROSTER_CHANGES. Questo campo deve essere specificato se feedType è COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informazioni su un Feed con un feedType di COURSE_WORK_CHANGES. Questo campo deve essere specificato se feedType è COURSE_WORK_CHANGES.
Fine dei campi che si escludono a vicenda.

FeedType

Un tipo di feed per cui un'applicazione può registrarsi per ricevere notifiche.

Enum
FEED_TYPE_UNSPECIFIED Non deve mai essere restituito o fornito.
DOMAIN_ROSTER_CHANGES

Tutte le modifiche ai roster per un determinato dominio.

Le notifiche verranno generate ogni volta che un utente si iscrive a un corso o lo abbandona.

Non verranno generate notifiche quando un invito viene creato o eliminato, ma verranno generate notifiche quando un utente si iscrive a un corso accettando un invito.
COURSE_ROSTER_CHANGES

Tutte le modifiche all'elenco degli studenti per un determinato corso.

Le notifiche verranno generate ogni volta che un utente si iscrive a un corso o lo abbandona.

Non verranno generate notifiche quando un invito viene creato o eliminato, ma verranno generate notifiche quando un utente si iscrive a un corso accettando un invito.
COURSE_WORK_CHANGES

Tutte le attività relative ai compiti di un determinato corso.

Le notifiche verranno generate quando viene creato o modificato un oggetto CourseWork o StudentSubmission. Non verrà generata alcuna notifica quando viene creato un oggetto StudentSubmission in relazione alla creazione o alla modifica dell'oggetto CourseWork principale (ma verrà generata una notifica per la creazione o la modifica dell'oggetto CourseWork).

CourseRosterChangesInfo

Informazioni su un Feed con un feedType di COURSE_ROSTER_CHANGES.

Rappresentazione JSON 
{
  "courseId": string
}
Campi
courseId

string

L'ID courseId del corso per cui vuoi iscriverti alle modifiche dell'elenco degli studenti.

CourseWorkChangesInfo

Informazioni su un Feed con un feedType di COURSE_WORK_CHANGES.

Rappresentazione JSON 
{
  "courseId": string
}
Campi
courseId

string

courseId del corso per cui iscriversi alle modifiche dei lavori.

CloudPubsubTopic

Un riferimento a un argomento Cloud Pub/Sub.

Per registrarsi alle notifiche, il proprietario dell'argomento deve concedere a classroom-notifications@system.gserviceaccount.com l'autorizzazione projects.topics.publish.

Rappresentazione JSON 
{
  "topicName": string
}
Campi
topicName

string

Il campo name di un argomento Cloud Pub/Sub.

Metodi

create

 Crea un Registration, in modo che Classroom inizi a inviare notifiche dal feed fornito alla destinazione fornita in cloudPubSubTopic.

delete

 Elimina un Registration, impedendo a Classroom di inviare notifiche per quel Registration.