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

アタッチメントが接続されている Announcement、CourseWork、または CourseWorkMaterial の識別子。このフィールドは必須ですが、postId からの移行中はそのようにマークされません。
addOnToken

string

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

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

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

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

string

省略可。アタッチメントの ID。ユーザーが Attachment Discovery iframe を使用している場合を除き、すべてのリクエストで必須フィールドです。

リクエスト本文

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

レスポンスの本文

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

認可スコープ

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

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

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