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 の有効期間。

サーバーによって割り当てられる読み取り専用フィールドです。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "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)

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 を作成します。これにより、Classroom は指定された feed から cloudPubSubTopic で指定された宛先へ通知の送信を開始します。

delete

 Registration を削除します。これにより、Classroom はその Registration の通知の送信を停止します。