Google Classroom API

Google Classroom のクラス、名簿、招待状を管理します。

サービス: classroom.googleapis.com

このサービスを呼び出すには、Google が提供するクライアント ライブラリを使用することをおすすめします。アプリケーションで独自のライブラリを使用してこのサービスを呼び出す必要がある場合は、API リクエストの際に次の情報を使用してください。

ディスカバリ ドキュメント

ディスカバリ ドキュメントは、REST API を記述して使用するための機械可読仕様です。クライアント ライブラリ、IDE プラグイン、Google API と連携するその他のツールのビルドに使用されます。1 つのサービスで複数のディスカバリ ドキュメントを提供できます。このサービスには、次の検索ドキュメントが用意されています。

サービス エンドポイント

サービス エンドポイントは、API サービスのネットワーク アドレスを指定するベース URL です。1 つのサービスに複数のサービス エンドポイントが存在することもあります。このサービスには次のサービス エンドポイントがあり、以下のすべての URI がこのサービス エンドポイントに関連しています。

  • https://classroom.googleapis.com

REST リソース: v1.courses

メソッド
checkAddOnCreationEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkAddOnCreationEligibility
ユーザーが特定のコース内でアドオン アタッチメントを作成できるかどうかを返します。
checkGradingPeriodsSetupEligibility
(deprecated)		 GET /v1/courses/{courseId}:checkGradingPeriodsSetupEligibility
ユーザーが特定のコース内の GradingPeriodSettings を更新する資格があるかどうかを返します。
create POST /v1/courses
コースを作成します。
delete DELETE /v1/courses/{id}
コースを削除します。
get GET /v1/courses/{id}
コースを返します。
getGradingPeriodSettings GET /v1/courses/{courseId}/gradingPeriodSettings
コースの採点期間の設定を返します。
list GET /v1/courses
リクエストしたユーザーが表示できるコースのリストを返します。リクエストに一致するコースのみが返されます。
patch PATCH /v1/courses/{id}
コースの 1 つ以上のフィールドを更新します。
update PUT /v1/courses/{id}
コースを更新します。
updateGradingPeriodSettings PATCH /v1/courses/{courseId}/gradingPeriodSettings
コースの採点期間の設定を更新します。

REST リソース: v1.courses.aliases

メソッド
create POST /v1/courses/{courseId}/aliases
コースのエイリアスを作成します。
delete DELETE /v1/courses/{courseId}/aliases/{alias}
コースのエイリアスを削除します。
list GET /v1/courses/{courseId}/aliases
コースのエイリアスのリストを返します。

REST リソース: v1.courses.announcements

メソッド
create POST /v1/courses/{courseId}/announcements
お知らせを作成します。
delete DELETE /v1/courses/{courseId}/announcements/{id}
通知を削除します。
get GET /v1/courses/{courseId}/announcements/{id}
お知らせを返します。
getAddOnContext GET /v1/courses/{courseId}/announcements/{itemId}/addOnContext
特定の投稿のコンテキストで Classroom アドオンのメタデータを取得します。
list GET /v1/courses/{courseId}/announcements
リクエスト元が表示できるお知らせのリストを返します。
modifyAssignees POST /v1/courses/{courseId}/announcements/{id}:modifyAssignees
アサインモードと通知のオプションを変更します。
patch PATCH /v1/courses/{courseId}/announcements/{id}
通知の 1 つ以上のフィールドを更新します。

REST リソース: v1.courses.announcements.addOnAttachments

メソッド
create POST /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
投稿の下にアドオンの添付ファイルを作成します。
delete DELETE /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
アドオンの添付ファイルを削除します。
get GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
アドオン添付を返します。
list GET /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments
投稿の下にあるアドオンによって作成されたすべてのアタッチメントを返します。
patch PATCH /v1/courses/{courseId}/announcements/{itemId}/addOnAttachments/{attachmentId}
アドオンの添付ファイルを更新します。

REST リソース: v1.courses.courseWork

メソッド
create POST /v1/courses/{courseId}/courseWork
コースの課題を作成します。
delete DELETE /v1/courses/{courseId}/courseWork/{id}
課題を削除します。
get GET /v1/courses/{courseId}/courseWork/{id}
コースワークを返します。
getAddOnContext GET /v1/courses/{courseId}/courseWork/{itemId}/addOnContext
特定の投稿のコンテキストで Classroom アドオンのメタデータを取得します。
list GET /v1/courses/{courseId}/courseWork
リクエスト元が閲覧を許可されているコースワークのリストを返します。
modifyAssignees POST /v1/courses/{courseId}/courseWork/{id}:modifyAssignees
課題の割り当てモードとオプションを変更します。
patch PATCH /v1/courses/{courseId}/courseWork/{id}
課題の 1 つ以上のフィールドを更新します。

REST リソース: v1.courses.courseWork.addOnAttachments

メソッド
create POST /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
投稿の下にアドオンの添付ファイルを作成します。
delete DELETE /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
アドオンの添付ファイルを削除します。
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
アドオン添付を返します。
list GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments
投稿の下にあるアドオンによって作成されたすべてのアタッチメントを返します。
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}
アドオンの添付ファイルを更新します。

REST リソース: v1.courses.courseWork.addOnAttachments.studentSubmissions

メソッド
get GET /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
アドオンの添付ファイルに関する生徒の提出物を返します。
patch PATCH /v1/courses/{courseId}/courseWork/{itemId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
アドオン添付ファイルの送信に関連付けられたデータを更新します。

REST リソース: v1.courses.courseWork.rubrics

メソッド
create POST /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
ルーブリックを作成します。
delete DELETE /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
ルーブリックを削除します。
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
ルーブリックを返します。
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics
リクエスト元が表示を許可されている評価尺度のリストを返します。
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/rubrics/{id}
評価基準を更新します。

REST リソース: v1.courses.courseWork.studentSubmissions

メソッド
get GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
生徒の提出物を返します。
list GET /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions
リクエストの OAuth スコープを考慮して、リクエスト元が閲覧を許可されている生徒の提出物のリストを返します。
modifyAttachments POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments
生徒の提出物の添付ファイルを変更します。
patch PATCH /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}
生徒の提出物の 1 つ以上のフィールドを更新します。
reclaim POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim
提出物の所有者である生徒に代わって、生徒の提出物を再取得します。
return POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return
生徒の提出物を返します。
turnIn POST /v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn
生徒の提出物を提出します。

REST リソース: v1.courses.courseWorkMaterials

メソッド
create POST /v1/courses/{courseId}/courseWorkMaterials
課題資料を作成します。
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{id}
課題資料を削除します。
get GET /v1/courses/{courseId}/courseWorkMaterials/{id}
コースワークの教材を返します。
getAddOnContext GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnContext
特定の投稿のコンテキストで Classroom アドオンのメタデータを取得します。
list GET /v1/courses/{courseId}/courseWorkMaterials
リクエスト元が閲覧を許可されている課題資料のリストを返します。
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{id}
コースワーク マテリアルの 1 つ以上のフィールドを更新します。

REST リソース: v1.courses.courseWorkMaterials.addOnAttachments

メソッド
create POST /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
投稿の下にアドオンの添付ファイルを作成します。
delete DELETE /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
アドオンの添付ファイルを削除します。
get GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
アドオン添付を返します。
list GET /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments
投稿の下にあるアドオンによって作成されたすべてのアタッチメントを返します。
patch PATCH /v1/courses/{courseId}/courseWorkMaterials/{itemId}/addOnAttachments/{attachmentId}
アドオンの添付ファイルを更新します。

REST リソース: v1.courses.posts

メソッド
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
特定の投稿のコンテキストで Classroom アドオンのメタデータを取得します。

REST リソース: v1.courses.posts.addOnAttachments

メソッド
create POST /v1/courses/{courseId}/posts/{postId}/addOnAttachments
投稿の下にアドオンの添付ファイルを作成します。
delete DELETE /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
アドオンの添付ファイルを削除します。
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
アドオン添付を返します。
list GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments
投稿の下にあるアドオンによって作成されたすべてのアタッチメントを返します。
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}
アドオンの添付ファイルを更新します。

REST リソース: v1.courses.posts.addOnAttachments.studentSubmissions

メソッド
get GET /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
アドオンの添付ファイルに関する生徒の提出物を返します。
patch PATCH /v1/courses/{courseId}/posts/{postId}/addOnAttachments/{attachmentId}/studentSubmissions/{submissionId}
アドオン添付ファイルの送信に関連付けられたデータを更新します。

REST リソース: v1.courses.students

メソッド
create POST /v1/courses/{courseId}/students
ユーザーをコースの生徒として追加します。
delete DELETE /v1/courses/{courseId}/students/{userId}
コースの生徒を削除します。
get GET /v1/courses/{courseId}/students/{userId}
コースの生徒を返します。
list GET /v1/courses/{courseId}/students
リクエスト元が閲覧を許可されている、このコースの生徒のリストを返します。

REST リソース: v1.courses.teachers

メソッド
create POST /v1/courses/{courseId}/teachers
コースの教師を作成します。
delete DELETE /v1/courses/{courseId}/teachers/{userId}
指定されたコースから指定された教師を削除します。
get GET /v1/courses/{courseId}/teachers/{userId}
コースの教師を返します。
list GET /v1/courses/{courseId}/teachers
リクエスト元が閲覧を許可されている、このコースの教師のリストを返します。

REST リソース: v1.courses.topics

メソッド
create POST /v1/courses/{courseId}/topics
トピックを作成します。
delete DELETE /v1/courses/{courseId}/topics/{id}
トピックを削除します。
get GET /v1/courses/{courseId}/topics/{id}
トピックを返します。
list GET /v1/courses/{courseId}/topics
リクエスト元が閲覧を許可されているトピックのリストを返します。
patch PATCH /v1/courses/{courseId}/topics/{id}
トピックの 1 つ以上のフィールドを更新します。

REST リソース: v1.invitations

メソッド
accept POST /v1/invitations/{id}:accept
招待を承認し、招待を削除して、招待したユーザーを指定されたコースの教師または生徒（該当する場合）に追加します。
create POST /v1/invitations
招待状を作成します。
delete DELETE /v1/invitations/{id}
招待を削除します。
get GET /v1/invitations/{id}
招待を返します。
list GET /v1/invitations
リクエスト元のユーザーが表示を許可されている招待状のリストを返します。リスト リクエストに一致するものに限定されます。

REST リソース: v1.registrations

メソッド
create POST /v1/registrations
Registration を作成します。これにより、指定された feed から cloudPubSubTopic で指定された宛先への通知の送信が Classroom で開始されます。
delete DELETE /v1/registrations/{registrationId}
Registration を削除し、その Registration に関する通知の送信を Classroom で停止します。

REST リソース: v1.userProfiles

メソッド
checkUserCapability GET /v1/userProfiles/{userId}:checkUserCapability
ユーザーが指定された Classroom 機能を使用できるかどうかを返します。
get GET /v1/userProfiles/{userId}
ユーザー プロフィールを返します。

REST リソース: v1.userProfiles.guardianInvitations

メソッド
create POST /v1/userProfiles/{guardianInvitation.studentId}/guardianInvitations
保護者への招待状を作成し、保護者に生徒の保護者であることを確認するよう求めるメールを送信します。
get GET /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
特定の保護者の招待を返します。
list GET /v1/userProfiles/{studentId}/guardianInvitations
リクエスト元のユーザーが表示を許可されている保護者の招待状のリストを、指定されたパラメータでフィルタして返します。
patch PATCH /v1/userProfiles/{studentId}/guardianInvitations/{invitationId}
保護者の招待状を変更します。

REST リソース: v1.userProfiles.guardians

メソッド
delete DELETE /v1/userProfiles/{studentId}/guardians/{guardianId}
保護者を削除します。
get GET /v1/userProfiles/{studentId}/guardians/{guardianId}
特定の保護者を返します。
list GET /v1/userProfiles/{studentId}/guardians
リクエストしたユーザーが閲覧を許可されている保護者のリストを返します。リクエストに一致する保護者に限定されます。