REST Resource: registrations

Recurso: Registro

Una instrucción a Classroom para enviar notificaciones desde la feed al destino proporcionado.

Representación JSON
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,
  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
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 el Registration es efectivo.

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

Una marca de tiempo en formato RFC3339 UTC "Zulu", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z" .

cloudPubsubTopic

object ( CloudPubsubTopic )

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

Alimento

Una clase de notificaciones que una aplicación puede registrarse para recibir. Por ejemplo: "todos los cambios de lista para 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 alimentación.

info del campo de unión. Parámetros adicionales sobre el feed. info puede ser solo uno de los siguientes:
courseRosterChangesInfo

object ( CourseRosterChangesInfo )

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

courseWorkChangesInfo

object ( CourseWorkChangesInfo )

Información sobre un Feed con un feedType de COURSE_WORK_CHANGES . Este campo debe especificarse si feedType es COURSE_WORK_CHANGES .

Tipo de alimentación

Un tipo de feed desde el que una aplicación puede registrarse para recibir notificaciones.

Enumeraciones
FEED_TYPE_UNSPECIFIED Nunca debe ser devuelto o proporcionado.
DOMAIN_ROSTER_CHANGES

Todos los cambios de lista para un dominio en particular.

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

No se generarán notificaciones cuando se cree o elimine una invitación, pero se generarán notificaciones cuando un usuario se una a un curso al aceptar una invitación.

COURSE_ROSTER_CHANGES

Todos los cambios de lista para un curso en particular.

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

No se generarán notificaciones cuando se cree o elimine una invitación, pero se generarán notificaciones cuando un usuario se una a un curso al aceptar una invitación.

COURSE_WORK_CHANGES

Toda 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

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

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

string

courseId del curso para suscribirse a los cambios de 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 suscribirse al trabajo cambia.

NubePubsubTema

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

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

Métodos

create

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

delete

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