REST Resource: registrations

Recurso: Registration

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

Representación 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.
}
Campos
registrationId

string

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

Solo lectura.
feed

object (Feed)

Es la especificación de la clase de notificaciones que Classroom debe entregar en el destino.
expiryTime

string (Timestamp format)

Es la fecha y hora hasta la que es válido el Registration.

Este es un campo de solo lectura que asigna el servidor.

Usa el formato RFC 3339, en el que el resultado generado siempre estará normalizado a Z y usará 0, 3, 6 o 9 dígitos fraccionarios. 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".
Campo de unión destination. Dónde se deben enviar las notificaciones Las direcciones (destination) solo pueden ser una de las siguientes opciones:
cloudPubsubTopic

object (CloudPubsubTopic)

Es el tema de Cloud Pub/Sub al que se enviarán las notificaciones.

Feed

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

Representación 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.
}
Campos
feedType

enum (FeedType)

Es el tipo de feed.
Campo de unión info. Son parámetros adicionales sobre el feed. Las direcciones (info) solo pueden ser una de las siguientes opciones:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

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

Es información sobre un Feed con un feedType de COURSE_WORK_CHANGES. Este campo se debe especificar si feedType es COURSE_WORK_CHANGES.

FeedType

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

Enumeraciones
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í se generarán cuando un usuario se una a un curso aceptando una invitación.
COURSE_ROSTER_CHANGES

Todos los cambios en la lista 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í se generarán cuando un usuario se una a un curso aceptando una invitación.
COURSE_WORK_CHANGES

Es la actividad de trabajo del curso para 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 principal (pero se generará una notificación para la creación o modificación de ese objeto CourseWork).

CourseRosterChangesInfo

Es 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á a los cambios en la lista.

CourseWorkChangesInfo

Es 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 al que se suscribirá para recibir notificaciones sobre los cambios en el trabajo.

CloudPubsubTopic

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

Para registrarse para 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

Es el campo name de un tema de Cloud Pub/Sub.

Métodos

create

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

delete

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