Method: courses.announcements.list

傳回要求者可查看的公告清單。

課程學生只能查看PUBLISHED公告。課程老師和網域管理員可以查看所有公告。

這個方法會傳回下列錯誤代碼：

  • PERMISSION_DENIED：如果要求使用者未獲准存取要求的課程，或發生存取錯誤。
  • INVALID_ARGUMENT：如果要求格式錯誤。
  • NOT_FOUND，如果要求的課程不存在。

HTTP 要求

GET https://classroom.googleapis.com/v1/courses/{courseId}/announcements

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
courseId

string

課程的 ID。這個 ID 可以是 Classroom 指派的 ID 或 alias。

查詢參數

參數
announcementStates[]

enum (AnnouncementState)

限制傳回的公告 state。如果未指定這個引數，預設值為 PUBLISHED。
orderBy

string

可選的結果排序順序。以半形逗號分隔的欄位清單，其中包含選用的排序方向關鍵字。支援的欄位為 updateTime。支援的方向關鍵字為 asc 和 desc。如未指定，預設行為為 updateTime desc。例如：updateTime asc、updateTime
pageSize

integer

傳回的項目數量上限。零或未指定的值表示伺服器可能會指派最大值。

伺服器傳回的結果數量可能少於指定數量。
pageToken

string

先前 list 呼叫傳回的 nextPageToken 值，表示應傳回後續的結果頁面。

list 要求必須與產生此權杖的要求完全相同。

要求主體

要求主體必須為空白。

回應主體

列出課程作業時的回應。

如果成功，回應主體會含有以下結構的資料：

JSON 表示法 
{
  "announcements": [
    {
      object (Announcement)
    }
  ],
  "nextPageToken": string
}
欄位
announcements[]

object (Announcement)

符合要求的公告項目。
nextPageToken

string

用於識別要傳回的下一頁結果的符記。如果留空，表示沒有其他結果。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/classroom.announcements
  • https://www.googleapis.com/auth/classroom.announcements.readonly

詳情請參閱授權指南。