REST Resource: registrations

리소스: Registration

feed에서 제공된 대상으로 알림을 보내라는 클래스룸에 대한 안내입니다.

JSON 표현 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
필드
registrationId

string

이 Registration의 서버 생성 고유 식별자입니다.

읽기 전용입니다.
feed

object (Feed)

클래스룸에서 대상으로 전송해야 하는 알림 클래스의 사양입니다.
expiryTime

string (Timestamp format)

Registration가 유효한 시간입니다.

서버에서 할당하는 읽기 전용 필드입니다.

생성된 출력은 항상 Z-정규화되고 소수점 이하 0, 3, 6 또는 9자리인 RFC 3339를 사용합니다. 'Z' 이외의 오프셋도 허용됩니다. 예를 들면 "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)

COURSE_ROSTER_CHANGES의 feedType가 있는 Feed에 관한 정보입니다. feedType가 COURSE_ROSTER_CHANGES인 경우 이 필드를 지정해야 합니다.
courseWorkChangesInfo

object (CourseWorkChangesInfo)

COURSE_WORK_CHANGES의 feedType가 있는 Feed에 관한 정보입니다. feedType가 COURSE_WORK_CHANGES인 경우 이 필드를 지정해야 합니다.
상호 배타적 필드의 끝입니다.

FeedType

애플리케이션이 알림을 등록할 수 있는 피드 유형입니다.

열거형
FEED_TYPE_UNSPECIFIED 반환되거나 제공되지 않습니다.
DOMAIN_ROSTER_CHANGES

특정 도메인의 모든 출석부 변경사항입니다.

사용자가 강의에 참여하거나 강의에서 나갈 때마다 알림이 생성됩니다.

초대가 생성되거나 삭제될 때는 알림이 생성되지 않지만 사용자가 초대를 수락하여 강의에 참여하면 알림이 생성됩니다.
COURSE_ROSTER_CHANGES

특정 과정의 모든 출석부 변경사항입니다.

사용자가 강의에 참여하거나 강의에서 나갈 때마다 알림이 생성됩니다.

초대가 생성되거나 삭제될 때는 알림이 생성되지 않지만, 사용자가 초대를 수락하여 강의에 참여하면 알림이 생성됩니다.
COURSE_WORK_CHANGES

특정 수업의 모든 수업 과제 활동

CourseWork 또는 StudentSubmission 객체가 생성되거나 수정되면 알림이 생성됩니다. 상위 CourseWork 객체의 생성 또는 수정과 관련하여 StudentSubmission 객체가 생성될 때는 알림이 생성되지 않습니다 (하지만 해당 CourseWork 객체의 생성 또는 수정에 대한 알림은 생성됨).

CourseRosterChangesInfo

COURSE_ROSTER_CHANGES의 feedType가 있는 Feed에 관한 정보입니다.

JSON 표현 
{
  "courseId": string
}
필드
courseId

string

출석부 변경사항을 구독할 강의의 courseId입니다.

CourseWorkChangesInfo

COURSE_WORK_CHANGES의 feedType가 있는 Feed에 관한 정보입니다.

JSON 표현 
{
  "courseId": string
}
필드
courseId

string

과제 변경사항을 구독할 강의의 courseId입니다.

CloudPubsubTopic

Cloud Pub/Sub 주제에 대한 참조입니다.

알림을 등록하려면 주제 소유자가 classroom-notifications@system.gserviceaccount.com에 projects.topics.publish 권한을 부여해야 합니다.

JSON 표현 
{
  "topicName": string
}
필드
topicName

string

Cloud Pub/Sub 주제의 name 필드입니다.

메서드

create

 Registration를 만들어 클래스룸에서 제공된 feed에서 cloudPubSubTopic에 제공된 대상으로 알림을 전송하기 시작합니다.

delete

 Registration를 삭제하여 클래스룸에서 해당 Registration에 대한 알림 전송을 중지합니다.