REST Resource: registrations

リソース: Registration

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

JSON 表現 
{
  "registrationId": string,
  "feed": {
    object (Feed)
  },
  "expiryTime": string,

  "cloudPubsubTopic": {
    object (CloudPubsubTopic)
  }
}
フィールド
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"。
通知の送信先。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
cloudPubsubTopic

object (CloudPubsubTopic)

通知の送信先となる Cloud Pub/Sub トピック。
相互に排他的なフィールドの終了。

フィード

アプリが受信登録できる通知のクラス。例: 「ドメインのすべての名簿の変更」。

JSON 表現 
{
  "feedType": enum (FeedType),

  "courseRosterChangesInfo": {
    object (CourseRosterChangesInfo)
  },
  "courseWorkChangesInfo": {
    object (CourseWorkChangesInfo)
  }
}
フィールド
feedType

enum (FeedType)

フィードのタイプ。
フィードに関する追加のパラメータ。相互に排他的なフィールドのリストは次のとおりです。レスポンスに設定されるフィールドは、最大 1 つです。
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 の通知の送信を停止します。