REST Resource: registrations

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

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

JSON-представление 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
Поля
registrationId

string

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

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

object (Feed)

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

string (Timestamp format)

Время, до которого действует Registration.

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

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

object (CloudPubsubTopic)

Тема Cloud Pub/Sub, в которую будут отправляться уведомления.
Конец взаимоисключающих полей.

Фид

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

JSON-представление 
{
  "feedType": enum (FeedType),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
Поля
feedType

enum (FeedType)

Тип фида.
Дополнительные параметры фида. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
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).

CourseRosterChangesInfo

Информация о типе 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, в результате чего Класс начинает отправлять уведомления из указанного feed в место назначения, указанное в cloudPubSubTopic.

delete

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