REST Resource: registrations

Ресурс: Регистрация

Инструкция для Classroom по отправке уведомлений из feed в указанный пункт назначения.

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.
}
Поля
registrationId

string

Уникальный идентификатор, сгенерированный сервером для данной Registration .

Только для чтения.

feed

object ( Feed )

Спецификация класса уведомлений, которые Classroom должен доставить по назначению.

expiryTime

string ( Timestamp format)

Срок действия Registration .

Это поле доступно только для чтения и назначается сервером.

Использует RFC 3339, согласно которому сгенерированный вывод всегда будет нормализован по оси Z и содержать 0, 3, 6 или 9 знаков после запятой. Также допускаются смещения, отличные от «Z». Примеры: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" или "2014-10-02T15:01:23+05:30" .

destination поля Union. Куда следует отправлять уведомления. destination может быть только одним из следующих:
cloudPubsubTopic

object ( CloudPubsubTopic )

Тема Cloud Pub/Sub, в которую будут отправляться уведомления.

Кормить

Класс уведомлений, на получение которых может зарегистрироваться приложение. Например: «все изменения в составе для домена».

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.
}
Поля
feedType

enum ( FeedType )

Тип корма.

info о поле объединения. Дополнительные параметры о фиде. info может быть только одним из следующих:
courseRosterChangesInfo

object ( CourseRosterChangesInfo )

Информация о Feed с feedType COURSE_ROSTER_CHANGES . Это поле должно быть заполнено, если feedType — COURSE_ROSTER_CHANGES .

courseWorkChangesInfo

object ( CourseWorkChangesInfo )

Информация о Feed с feedType COURSE_WORK_CHANGES . Это поле должно быть заполнено, если feedType — COURSE_WORK_CHANGES .

FeedType

Тип канала, уведомления из которого приложение может зарегистрировать.

Перечисления
FEED_TYPE_UNSPECIFIED Ни в коем случае не подлежит возврату или предоставлению.
DOMAIN_ROSTER_CHANGES

Все изменения в составе для определенного домена.

Уведомления будут генерироваться всякий раз, когда пользователь присоединяется к курсу или покидает его.

При создании или удалении приглашения уведомления не генерируются, но уведомления будут созданы, когда пользователь присоединится к курсу, приняв приглашение.

COURSE_ROSTER_CHANGES

Все изменения в составе для конкретного курса.

Уведомления будут генерироваться всякий раз, когда пользователь присоединяется к курсу или покидает его.

При создании или удалении приглашения уведомления не генерируются, но уведомления будут созданы, когда пользователь присоединится к курсу, приняв приглашение.

COURSE_WORK_CHANGES

Вся курсовая деятельность по определенному курсу.

Уведомления будут создаваться при создании или изменении объектов CourseWork или StudentSubmission. При создании объекта StudentSubmission в связи с созданием или изменением его родительского объекта CourseWork уведомления не создаются (но при создании или изменении этого объекта CourseWork уведомление будет создано).

Информация об изменениях в составе курса

Информация о Feed с feedType COURSE_ROSTER_CHANGES .

JSON-представление 
{
  "courseId": string
}
Поля
courseId

string

courseId курса, на который нужно подписаться, чтобы изменить список.

CourseWorkChangesInfo

Информация о Feed с feedType COURSE_WORK_CHANGES .

JSON-представление 
{
  "courseId": string
}
Поля
courseId

string

courseId курса, на который нужно подписаться, чтобы изменить работу.

CloudPubsubTopic

Ссылка на тему Cloud Pub/Sub.

Чтобы зарегистрироваться для получения уведомлений, владелец темы должен предоставить classroom-notifications@system.gserviceaccount.com разрешение projects.topics.publish .

JSON-представление 
{
  "topicName": string
}
Поля
topicName

string

Поле name темы Cloud Pub/Sub.

Методы

create

 Создает Registration , в результате чего Classroom начинает отправлять уведомления из предоставленного feed в пункт назначения, указанный в cloudPubSubTopic .

delete

 Удаляет Registration , в результате чего Classroom прекращает отправку уведомлений для этой Registration .