- リソース: Registration
- フィード
- FeedType
- CourseRosterChangesInfo
- CourseWorkChangesInfo
- CloudPubsubTopic
- メソッド
リソース: Registration
feed
から指定した宛先に通知を送信するよう Classroom に指示します。
JSON 表現 |
---|
{ "registrationId": string, "feed": { object ( |
フィールド | |
---|---|
registrationId |
この 読み取り専用です。 |
feed |
Classroom が宛先に配信する通知クラスの仕様。 |
expiryTime |
サーバーによって割り当てられる読み取り専用のフィールドです。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
共用体フィールド destination 。通知の送信先。destination は次のいずれかになります。 |
|
cloudPubsubTopic |
通知の送信先となる Cloud Pub/Sub トピック。 |
フィード
アプリケーションが受信登録できる通知のクラス。例: 「ドメインのすべての名簿変更」
JSON 表現 |
---|
{ "feedType": enum ( |
フィールド | |
---|---|
feedType |
フィードのタイプ。 |
共用体フィールド info 。フィードに関するその他のパラメータ。info は次のいずれかになります。 |
|
courseRosterChangesInfo |
|
courseWorkChangesInfo |
|
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 |
名簿の変更を受け取るコースの |
CourseWorkChangesInfo
feedType
が COURSE_WORK_CHANGES
の Feed
に関する情報。
JSON 表現 |
---|
{ "courseId": string } |
フィールド | |
---|---|
courseId |
購読するコースの |
CloudPubsubTopic
Cloud Pub/Sub トピックへの参照。
通知を登録するには、トピックのオーナーが classroom-notifications@system.gserviceaccount.com
に projects.topics.publish
権限を付与する必要があります。
JSON 表現 |
---|
{ "topicName": string } |
フィールド | |
---|---|
topicName |
Cloud Pub/Sub トピックの |
Methods |
|
---|---|
|
Registration を作成します。これにより、Classroom は指定された feed から cloudPubSubTopic で指定された宛先への通知の送信を開始します。 |
|
Registration を削除し、Classroom はその Registration の通知の送信を停止します。 |