傳回允許要求者查看的公告清單。
課程學生只能查看「PUBLISHED
」的公告。課程老師和網域管理員可以查看所有公告。
這個方法會傳回下列錯誤代碼:
PERMISSION_DENIED
:要求的使用者無法存取要求的課程,或是存取錯誤。- 如果要求格式錯誤,則為
INVALID_ARGUMENT
。 - 如果要求的課程不存在,則為
NOT_FOUND
。
HTTP 要求
GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements
這個網址使用 gRPC 轉碼語法。
路徑參數
參數 | |
---|---|
courseId |
課程的 ID。這個 ID 可以是 Classroom 指派的 ID 或 |
查詢參數
參數 | |
---|---|
announcementStates[] |
傳回的公告 |
orderBy |
結果的排序排序 (選用)。以半形逗號分隔的欄位清單,其中包含選用的排序方向關鍵字。支援的欄位為「 |
pageSize |
要傳回的項目數上限。0 或未指定時,表示伺服器可能會指派上限。 伺服器傳回的結果數量可能會少於指定數量。 |
pageToken |
從先前的
|
要求主體
要求主體必須為空白。
回應主體
列出課程作業時的回應。
如果成功,回應主體即會包含具有以下結構的資料:
JSON 表示法 |
---|
{
"announcements": [
{
object ( |
欄位 | |
---|---|
announcements[] |
符合要求的公告項目。 |
nextPageToken |
用於識別下一頁結果的權杖。如果留空,系統就不會顯示進一步結果。 |
授權範圍
需要下列其中一種 OAuth 範圍:
https://www.googleapis.com/auth/classroom.announcements
https://www.googleapis.com/auth/classroom.announcements.readonly
詳情請參閱授權指南。