Method: courses.courseWorkMaterials.getAddOnContext

取得特定訊息背景資訊的 Classroom 外掛程式中繼資料。

為了維護其自有資料和權限模型的完整性，外掛程式每次在 iframe 中開啟外掛程式時，都必須呼叫這個參數，以驗證查詢參數和提出要求的使用者角色。

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

  • PERMISSION_DENIED 代表存取錯誤。
  • 如果要求格式錯誤，則為 INVALID_ARGUMENT。
  • NOT_FOUND：如果其中一項識別的資源不存在。

HTTP 要求

GET https://classroom.googleapis.com/v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext

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

路徑參數

參數
courseId

string

必要欄位。課程的 ID。
itemId

string

附加附件的 Announcement、CourseWork 或 CourseWorkMaterial ID。這是必要欄位，不過在從 postId 進行遷移時，系統不會標示此欄位。

查詢參數

參數
addOnToken

string

選用設定。授權要求的權杖。

當使用者從 Classroom 重新導向至外掛程式的網址時，系統會將權杖做為查詢參數傳遞。

如果下列兩種情況皆無效，則須提供授權權杖：

  • 外掛程式會在訊息中加上附件。
  • 發出要求的開發人員專案與建立貼文的專案相同。
attachmentId

string

選用設定。附件的 ID。這個欄位適用於所有要求，但使用者位於附件探索 iframe 時除外。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體會包含 AddOnContext 的執行例項。

授權範圍

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

  • https://www.googleapis.com/auth/classroom.addons.student
  • https://www.googleapis.com/auth/classroom.addons.teacher

詳情請參閱授權指南。