Method: courses.aliases.list

傳回課程別名清單。

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

  • 如果提出要求的使用者沒有存取課程或存取錯誤的權限，則為 PERMISSION_DENIED。
  • 如果課程不存在，則為 NOT_FOUND。

HTTP 要求

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

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

路徑參數

參數
courseId

string

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

查詢參數

參數
pageSize

integer

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

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

string

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

list 要求必須與導致這個權杖的要求相同，

要求主體

要求主體必須為空白。

回應主體

列出課程別名時的回應。

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

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

object (CourseAlias)

課程別名。
nextPageToken

string

用於識別要傳回下一頁結果的權杖。如果空白，表示沒有進一步的結果。

授權範圍

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

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

詳情請參閱授權指南。