REST Resource: registrations

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Recurso: Registro

Una instrucción a Classroom para enviar notificaciones desde el 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 para la clase de notificaciones que Classroom debe entregar al destino.

expiryTime

string (Timestamp format)

El tiempo hasta que el Registration es efectivo.

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

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos decimales. 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 enviarán las notificaciones

Feed

Una clase de notificaciones que una aplicación puede registrar. Por ejemplo, "todos los cambios en 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. 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. 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 feed

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

Enumeradores
FEED_TYPE_UNSPECIFIED Nunca deben devolverse ni proporcionarse.
DOMAIN_ROSTER_CHANGES

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

Las notificaciones se generarán siempre 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 cuando un usuario se una a un curso, se aceptará una notificación.

COURSE_ROSTER_CHANGES

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

Las notificaciones se generarán siempre 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 cuando un usuario se una a un curso, se aceptará una notificación.

COURSE_WORK_CHANGES

Toda la actividad laboral de 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).

InformaciónDeCambiosDeRoster del curso

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

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

string

Los courseId del curso para los que deseas suscribirte a los cambios de la lista.

Información sobre cambios en el trabajo del curso

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

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

string

Los cambios en el courseId del curso para suscribirse al trabajo.

Subtema de Cloud Pub/Sub

Una referencia a un tema de Cloud Pub/Sub.

Si quieres registrarte para recibir notificaciones, el propietario del tema debe otorgar el permiso projects.topics.publish a classroom-notifications@system.gserviceaccount.com.

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 hará que Classroom deje de enviar notificaciones para ese Registration.