REST Resource: registrations

Recurso: Registration

Una instrucción para que Classroom envíe notificaciones desde el feed al destino proporcionado.

Representación JSON 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

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

string

Es un identificador único generado por el servidor para este Registration.

Solo lectura.
feed

object (Feed)

Especificación de la clase de notificaciones que Classroom debe entregar al destino.
expiryTime

string (Timestamp format)

Es la hora hasta la que el Registration es efectivo.

Este es un campo de solo lectura asignado por el servidor.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
Dónde se deben enviar las notificaciones. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
cloudPubsubTopic

object (CloudPubsubTopic)

Es el tema de Cloud Pub/Sub al que se enviarán las notificaciones.
Fin de los campos mutuamente excluyentes.

Feed

Es una clase de notificaciones que una aplicación puede registrar para recibir. Por ejemplo: "todos los cambios en la lista de un dominio".

Representación JSON 
{
  "feedType": enum (FeedType),

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

enum (FeedType)

Es el tipo de feed.
Son parámetros adicionales sobre el feed. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Información sobre un Feed con un feedType de COURSE_ROSTER_CHANGES. Este campo se debe especificar si feedType es COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Información sobre un Feed con un feedType de COURSE_WORK_CHANGES. Este campo se debe especificar si feedType es COURSE_WORK_CHANGES.
Fin de los campos mutuamente excluyentes.

FeedType

Es un tipo de feed en el que una aplicación puede registrarse para recibir notificaciones.

Enums
FEED_TYPE_UNSPECIFIED Nunca se debe devolver ni proporcionar.
DOMAIN_ROSTER_CHANGES

Todos los cambios en la lista de un dominio en particular.

Se generarán notificaciones cada vez que un usuario se una a un curso o lo abandone.

No se generarán notificaciones cuando se cree o borre una invitación, pero sí cuando un usuario se una a un curso aceptando una invitación.
COURSE_ROSTER_CHANGES

Todos los cambios en la lista de alumnos de un curso en particular.

Se generarán notificaciones cada vez que un usuario se una a un curso o lo abandone.

No se generarán notificaciones cuando se cree o borre una invitación, pero sí cuando un usuario se una a un curso aceptando una invitación.
COURSE_WORK_CHANGES

Toda la actividad de trabajo de un curso en particular.

Se generarán notificaciones cuando se cree o modifique un objeto CourseWork o StudentSubmission. No se generará ninguna notificación cuando se cree un objeto StudentSubmission en relación con la creación o modificación de su objeto CourseWork superior (pero se generará una notificación para la creación o modificación de ese objeto CourseWork).

CourseRosterChangesInfo

Información sobre un Feed con un feedType de COURSE_ROSTER_CHANGES.

Representación JSON 
{
  "courseId": string
}
Campos
courseId

string

Es el courseId del curso para el que se suscribirán los cambios en la lista de alumnos.

CourseWorkChangesInfo

Información sobre un Feed con un feedType de COURSE_WORK_CHANGES.

Representación JSON 
{
  "courseId": string
}
Campos
courseId

string

Es el courseId del curso para el que se suscribirán los cambios en el trabajo.

CloudPubsubTopic

Es una referencia a un tema de Cloud Pub/Sub.

Para registrarse y recibir notificaciones, el propietario del tema debe otorgar a classroom-notifications@system.gserviceaccount.com el permiso projects.topics.publish.

Representación JSON 
{
  "topicName": string
}
Campos
topicName

string

El campo name de un tema de Cloud Pub/Sub.

Métodos

create

 Crea un Registration, lo que hace que Classroom comience a enviar notificaciones desde el feed proporcionado al destino proporcionado en cloudPubSubTopic.

delete

 Borra un Registration, lo que hace que Classroom deje de enviar notificaciones para ese Registration.