REST Resource: registrations

Recurso: registro

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,

  // 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 esse Registration.

Somente leitura.

feed

object (Feed)

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

expiryTime

string (Timestamp format)

O tempo até que a Registration seja efetiva.

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

Um carimbo de data/hora no formato RFC3339 UTC "Zulu", 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 app pode registrar para receber. Por exemplo: "todas as mudanças de lista de participantes 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. 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.

FeedType

Um tipo de feed que um app pode 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 membros de um domínio específico.

As notificações são geradas sempre que um usuário entra ou sai de um curso.

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

COURSE_ROSTER_CHANGES

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

As notificações são geradas sempre que um usuário entra ou sai de um curso.

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

COURSE_WORK_CHANGES

Todas as atividades do curso para 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 assinar as mudanças na grade.

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 assinar as mudanças de trabalho.

CloudPubsubTopic

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

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

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 informado em cloudPubSubTopic.

delete

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