REST Resource: registrations

Recurso: Registration

Instrução para o Google Sala de Aula enviar notificações do feed para o destino informado.

Representação 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

Um identificador exclusivo gerado pelo servidor para este Registration.

Somente leitura.

feed

object (Feed)

Especificação da turma de notificações que o Google Sala de Aula precisa enviar para o destino.

expiryTime

string (Timestamp format)

O período em que a Registration entra em vigor.

Este é um campo somente leitura atribuído pelo servidor.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".

Campo de união destination. Para onde as notificações devem ser enviadas. destination pode ser apenas de um dos tipos a seguir:
cloudPubsubTopic

object (CloudPubsubTopic)

O tópico do Cloud Pub/Sub para onde as notificações serão enviadas.

Feed

Uma classe de notificações que um aplicativo pode se registrar para receber. Por exemplo: "Todas as alterações na lista de estudantes de um domínio".

Representação 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)

O tipo de feed.

Campo de união info. Parâmetros adicionais sobre o feed. info pode ser apenas de um dos tipos a seguir:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informações sobre um Feed com um feedType de COURSE_ROSTER_CHANGES. Esse campo precisará ser especificado se feedType for COURSE_ROSTER_CHANGES.

courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informações sobre um Feed com um feedType de COURSE_WORK_CHANGES. Esse campo precisará ser especificado se feedType for COURSE_WORK_CHANGES.

FeedType

Um tipo de feed do qual um aplicativo pode se registrar para receber notificações.

Enums
FEED_TYPE_UNSPECIFIED Nunca deve ser retornado ou fornecido.
DOMAIN_ROSTER_CHANGES

Todas as mudanças na lista de estudantes de um domínio específico.

Sempre que um usuário entra ou sai de um curso, uma notificação é gerada.

Nenhuma notificação será gerada quando um convite for criado ou excluído, mas uma notificação será gerada quando um usuário aceitar um convite para participar de um curso.

COURSE_ROSTER_CHANGES

Todas as mudanças na lista de estudantes de um curso específico.

Sempre que um usuário entra ou sai de um curso, uma notificação é gerada.

Nenhuma notificação será gerada quando um convite for criado ou excluído, mas uma notificação será gerada quando um usuário aceitar um convite para participar de um curso.

COURSE_WORK_CHANGES

Todas as atividades de um curso específico.

Notificações serão geradas quando um objeto CourseWork ou StudentSubmission for criado ou modificado. Nenhuma notificação será gerada quando um objeto StudentSubmission for criado em relação à criação ou modificação do objeto CourseWork pai dele, mas uma notificação será gerada para a criação ou modificação desse objeto.

CourseRosterChangesInfo

Informações sobre um Feed com um feedType de COURSE_ROSTER_CHANGES.

Representação JSON
{
  "courseId": string
}
Campos
courseId

string

O courseId do curso em que você vai receber mudanças na lista de estudantes.

CourseWorkChangesInfo

Informações sobre um Feed com um feedType de COURSE_WORK_CHANGES.

Representação JSON
{
  "courseId": string
}
Campos
courseId

string

O courseId do curso para inscrição nas mudanças de trabalho.

CloudPubsubTopic

Uma referência a um tópico do Cloud Pub/Sub.

Para receber notificações, o proprietário do tópico precisa conceder a permissão projects.topics.publish a classroom-notifications@system.gserviceaccount.com.

Representação JSON
{
  "topicName": string
}
Campos
topicName

string

O campo name de um tópico do Cloud Pub/Sub.

Métodos

create

Cria um Registration, fazendo com que o Google Sala de Aula comece a enviar notificações do feed informado para o destino informado no cloudPubSubTopic.

delete

Exclui um Registration, fazendo com que o Google Sala de Aula pare de enviar notificações para esse Registration.