Method: courses.posts.getAddOnContext

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

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

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
courseId

string

必須。コースの識別子。
postId
(deprecated)

string

（省略可）非推奨です。代わりに itemId を使用してください。

クエリ パラメータ

パラメータ
itemId

string

添付ファイルに添付されているお知らせ、courseWork、または courseWorkMaterial の識別子。このフィールドは必須ですが、postId からの移行ではマークされません。
addOnToken

string

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

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

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

  • アドオンには投稿に添付されています。
  • リクエストを発行したデベロッパー プロジェクトは、投稿を作成したプロジェクトと同じです。

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

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

詳細については、承認ガイドをご覧ください。