REST Resource: registrations

Recurso: Registration

Uma instrução para o Google Sala de Aula enviar notificações do feed para o destino fornecido.

Representação JSON 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
Campos
registrationId

string

Um identificador exclusivo gerado pelo servidor para este Registration.

Somente leitura.
feed

object (Feed)

Especificação da classe de notificações que o Google Sala de Aula deve enviar ao destino.
expiryTime

string (Timestamp format)

O horário até o qual o Registration é válido.

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

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
Para onde as notificações devem ser enviadas. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
cloudPubsubTopic

object (CloudPubsubTopic)

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

Feed

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

Representação JSON 
{
  "feedType": enum (FeedType),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
Campos
feedType

enum (FeedType)

O tipo de feed.
Parâmetros adicionais sobre o feed. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
courseRosterChangesInfo

object (CourseRosterChangesInfo)

Informações sobre um Feed com um feedType de COURSE_ROSTER_CHANGES. Este campo precisa ser especificado se feedType for COURSE_ROSTER_CHANGES.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

Informações sobre um Feed com um feedType de COURSE_WORK_CHANGES. Este campo precisa ser especificado se feedType for COURSE_WORK_CHANGES.
Fim dos campos mutuamente exclusivos.

FeedType

Um tipo de feed que um aplicativo pode registrar para receber notificações.

Tipos enumerados
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.

As notificações serão geradas sempre que um usuário entrar ou sair de um curso.

Nenhuma notificação será gerada quando um convite for criado ou excluído, mas as notificações serão geradas quando um usuário entrar em um curso aceitando um convite.
COURSE_ROSTER_CHANGES

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

As notificações serão geradas sempre que um usuário entrar ou sair de um curso.

Nenhuma notificação será gerada quando um convite for criado ou excluído, mas as notificações serão geradas quando um usuário entrar em um curso aceitando um convite.
COURSE_WORK_CHANGES

Todas as atividades de um curso específico.

As 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 conexão com a criação ou modificação do objeto CourseWork pai (mas uma notificação será gerada para a criação ou modificação desse objeto CourseWork).

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 para se inscrever nas 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 se inscrever nas mudanças de trabalho.

CloudPubsubTopic

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

Para se registrar para receber notificações, o proprietário do tópico precisa conceder a permissão projects.topics.publish ao 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 fornecido para o destino fornecido em cloudPubSubTopic.

delete

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