REST Resource: registrations

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

Инструкция Классу отправлять уведомления из 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 )

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

expiryTime

string ( Timestamp format)

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

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

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

destination поля Союза. Куда отправлять уведомления. 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 .

Тип фида

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

Перечисления
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 курса, на который нужно подписаться на изменения списка.

КурсРаботаИзмененияИнформация

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

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

string

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

ОблакоPubsubTopic

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

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

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

string

Поле name Cloud Pub/Sub Topic .

Методы

create

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

delete

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