REST Resource: registrations

リソース: Registration

feed から指定された宛先に通知を送信するよう Classroom に指示する。

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。通知の送信先。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)

feedType が COURSE_ROSTER_CHANGES の Feed に関する情報。feedType が COURSE_ROSTER_CHANGES の場合、このフィールドを指定する必要があります。
courseWorkChangesInfo

object (CourseWorkChangesInfo)

feedType が COURSE_WORK_CHANGES の Feed に関する情報。feedType が COURSE_WORK_CHANGES の場合、このフィールドを指定する必要があります。

FeedType

アプリが通知を登録できるフィードのタイプ。

列挙型
FEED_TYPE_UNSPECIFIED 返却または提供してはいけません。
DOMAIN_ROSTER_CHANGES

特定のドメインのすべてのロースター変更。

ユーザーがコースに参加または退出するたびに、通知が生成されます。

招待の作成や削除時に通知は生成されませんが、ユーザーが招待を承諾してコースに参加すると通知が生成されます。
COURSE_ROSTER_CHANGES

特定のコースに関するすべての名簿変更。

ユーザーがコースに参加または退出するたびに、通知が生成されます。

招待の作成や削除時に通知は生成されませんが、ユーザーが招待を承諾してコースに参加すると通知が生成されます。
COURSE_WORK_CHANGES

特定のコースに関するすべての課題アクティビティ。

通知は、CourseWork オブジェクトまたは StudentSubmission オブジェクトが作成または変更されたときに生成されます。親の CourseWork オブジェクトの作成または変更に関連して StudentSubmission オブジェクトが作成された場合、通知は生成されません（ただし、その CourseWork オブジェクトの作成または変更については通知が生成されます）。

CourseRosterChangesInfo

feedType が COURSE_ROSTER_CHANGES の Feed に関する情報。

JSON 表現 
{
  "courseId": string
}
フィールド
courseId

string

名簿の変更をサブスクライブするコースの courseId。

CourseWorkChangesInfo

feedType が COURSE_WORK_CHANGES の 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 に関する通知が Classroom から送信されなくなります。