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

附加附件的公告、CourseWork 或 pathWorkMaterial 的 ID。此為必填欄位，但系統從 postId 遷移時並未標示這類欄位。

查詢參數

參數
addOnToken

string

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

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

如果符合下列任何條件，則需要授權權杖：

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

要求主體

要求主體必須為空白。

回應主體

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

授權範圍

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

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

詳情請參閱授權指南。