REST Resource: registrations

Risorsa: Registrazione

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

Rappresentazione JSON 
{
  "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.
}
Campi
registrationId

string

Un identificatore univoco generato dal server per questo Registration.

Sola lettura.
feed

object (Feed)

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

string (Timestamp format)

Il periodo di tempo fino al quale è valida la Registration.

Questo è un campo di sola lettura assegnato dal server.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC 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".
Campo unione destination. Dove devono essere inviate le notifiche. destination può essere solo uno dei seguenti:
cloudPubsubTopic

object (CloudPubsubTopic)

L'argomento Cloud Pub/Sub a cui inviare le notifiche.

Feed

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

Rappresentazione JSON 
{
  "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.
}
Campi
feedType

enum (FeedType)

Il tipo di feed.
Campo unione info. Parametri aggiuntivi sul feed. info può essere solo uno dei seguenti:
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.

FeedType

Un tipo di feed a 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 all'elenco 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 viene creato o eliminato un invito, ma verranno generate quando un utente partecipa a un corso accettando un invito.
COURSE_ROSTER_CHANGES

Tutte le modifiche all'elenco 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 viene creato o eliminato un invito, ma verranno generate quando un utente partecipa a un corso accettando un invito.
COURSE_WORK_CHANGES

Tutta l'attività dei lavori del corso per un determinato corso.

Le notifiche vengono 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 del relativo 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

Il courseId del corso per cui vuoi iscriverti alle modifiche dell'elenco.

CourseWorkChangesInfo

Informazioni su un Feed con un feedType di COURSE_WORK_CHANGES.

Rappresentazione JSON 
{
  "courseId": string
}
Campi
courseId

string

Il courseId del corso per cui vuoi abbonarti alle modifiche del lavoro.

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, facendo in modo che Classroom inizi a inviare notifiche dall'feed fornito alla destinazione indicata in cloudPubSubTopic.

delete

 Elimina un Registration, facendo in modo che Classroom smetta di inviare notifiche per quel Registration.