REST Resource: registrations

Recurso: Registration

Una instrucción a Classroom para enviar notificaciones de 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

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)

El tiempo hasta el cual Registration entra en vigencia.

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

Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
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)

El tema de Cloud Pub/Sub al que se deben enviar las notificaciones.

Feed

Es una clase de notificaciones que una aplicación puede registrarse 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)

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

object (CourseRosterChangesInfo)

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

object (CourseWorkChangesInfo)

Información sobre un Feed con un feedType de COURSE_WORK_CHANGES. Se debe especificar este campo si feedType es COURSE_WORK_CHANGES.

FeedType

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

Enumeraciones
FEED_TYPE_UNSPECIFIED Nunca se deben devolver ni proporcionar.
DOMAIN_ROSTER_CHANGES

Todos los cambios de 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 luego de aceptarla.
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í cuando un usuario se una a un curso luego de aceptarla.
COURSE_WORK_CHANGES

Toda la actividad de trabajo del curso correspondiente a un curso en particular.

Las notificaciones se generarán 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

El courseId del curso para el que se realizará la suscripción a los cambios de la lista.

CourseWorkChangesInfo

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

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

string

El courseId del curso para el que se realizará la suscripción a los cambios de trabajo.

CloudPubsubTopic

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

Si deseas registrarte 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

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 del feed proporcionado al destino proporcionado en cloudPubSubTopic.

delete

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