Method: courses.posts.getAddOnContext

取得特定貼文脈絡中 Classroom 外掛程式的中繼資料。

為了維持資料和權限模型的完整性，在iframe 中開啟外掛程式時，外掛程式應呼叫此方法，驗證查詢參數和要求使用者的角色。

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

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

HTTP 要求

GET https://classroom.googleapis.com/v1/courses/{courseId}/posts/{postId}/addOnContext

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

路徑參數

參數
courseId

string

必要欄位。課程的 ID。
postId
(deprecated)

string

選用設定。已淘汰，請改用 itemId。

查詢參數

參數
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

詳情請參閱授權指南。