Method: courses.courseWorkMaterials.getAddOnContext

特定の投稿のコンテキストで Classroom アドオンのメタデータを取得します。

独自のデータと権限モデルの整合性を維持するため、アドオンは iframe で開かれるたびにこれを呼び出して、クエリ パラメータとリクエスト元のユーザーのロールを確認する必要があります。

このメソッドは、次のエラーコードを返します。

  • PERMISSION_DENIED: アクセス エラー。
  • INVALID_ARGUMENT: リクエストの形式が正しくない場合。
  • NOT_FOUND: 検出されたリソースのいずれかが存在しない場合。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
courseId

string

必須。コースの識別子。
itemId

string

添付ファイルが接続されている Announcement、CourseWork、CourseWorkMaterial の ID。このフィールドは必須ですが、postId から移行中は必須としてマークされません。

クエリ パラメータ

パラメータ
addOnToken

string

省略可。リクエストを承認するトークン。

トークンは、ユーザーが Classroom からアドオンの URL にリダイレクトされたときにクエリ パラメータとして渡されます。

次のいずれにも該当しない場合は、認可トークンが必要です。

  • アドオンの投稿に添付ファイルがある。
  • リクエストを発行するデベロッパー プロジェクトは、投稿を作成したプロジェクトと同じです。
attachmentId

string

省略可。添付ファイルの識別子。このフィールドは、ユーザーが添付ファイル検出の iframe 内にいる場合を除き、すべてのリクエストで必須です。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文には AddOnContext のインスタンスが含まれます。

認可スコープ

以下のいずれかの OAuth スコープが必要です。

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

詳しくは、認可ガイドをご覧ください。