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

Methods
checkAddOnCreationEligibility GET /v1/courses/{courseId}:checkAddOnCreationEligibility
特定のコースで、ユーザーがアドオンの添付ファイルを作成できるかどうかを返します。
create POST /v1/courses
コースを作成します。
delete DELETE /v1/courses/{id}
コースを削除します。
get GET /v1/courses/{id}
コースを返します。
list GET /v1/courses
リクエストを行ったユーザーが閲覧を許可されているコースのリストを、リクエストに一致するコースに限定して返します。
patch PATCH /v1/courses/{id}
コース内の 1 つ以上のフィールドを更新します。
update PUT /v1/courses/{id}
コースを更新します。

REST リソース: v1.courses.aliases

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

REST リソース: v1.courses.announcements

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
getAddOnContext GET /v1/courses/{courseId}/posts/{postId}/addOnContext
特定の投稿に関する Classroom アドオンのメタデータを取得します。

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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

Methods
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

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

REST リソース: v1.userProfiles

Methods
get GET /v1/userProfiles/{userId}
ユーザー プロフィールを返します。

REST リソース: v1.userProfiles.guardianInvitations

Methods
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

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