ユーザーが Classroom と Google Meet を使用している場合は、Google Meet コースの生徒の出席状況を確認する Apps Script クイックスタートをご覧ください。

概要

Classroom API は、Google Classroom でコースや名簿を管理するための RESTful インターフェースを提供します。また、Classroom の共有ボタンを使用することで、デベロッパーやコンテンツ所有者は Classroom とのコンテンツ共有を有効にできます。

API を使用できるユーザー

G Suite for Education ドメイン管理者は、API を使用してプログラムで教師に代わってプログラムをプロビジョニングしたり、生徒情報システムを Classroom と同期したり、ドメインで担当しているクラスの基本的な可視性を確保したりできます。

アプリケーションのデベロッパーは Classroom API を使用してアプリを Classroom と統合できます。これらのアプリでは、OAuth 2.0 を使用して、教師のクラスと名簿を表示するための権限をリクエストする必要があります。管理者は、ドメイン内の教師と生徒が Google Classroom データへのアクセスをアプリに許可できるかどうかを制限できます。

ウェブサイトの所有者とコンテンツ デベロッパーは、Classroom の共有ボタンを使用して、生徒と教師が Classroom でコンテンツを共有できるようになります。

API と Classroom の共有ボタンの統合はすべて、Classroom のブランド ガイドラインに準拠している必要があります。

API の概要

Classroom API は複数のエンティティ タイプで構成され、Classroom のインターフェースに含まれるクラス、教師、生徒に対応しています。これらのエンティティの中には、Classroom に存在するものに加えて、API に固有の追加プロパティを持つものがあります。主なエンティティ タイプは次のとおりです。

API のリソースとメソッドの詳細については、Classroom API リファレンスをご覧ください。

コースのメタデータとエイリアス

コースは、「M」などのクラスを表します。スミスの 第 4 期の数学とその 担当する教師、受講生名簿、メタデータ。各コースは、サーバーによって割り当てられた一意の ID によって識別されます。具体的には、コースリソースには名前、説明、場所、時間など、コースに関するすべてのメタデータがカプセル化されています。コースの名簿は、生徒教師招待のリソースとそのメソッドを使用して管理します。

エイリアスはクラスの代替識別子であり、コースに関連付けられ、一意の ID の代わりに使用されます。各エイリアスは、作成や表示が可能なユーザーを制限する名前空間に存在します。次の 2 つの名前空間がサポートされます。

  • ドメイン: ドメインの名前空間は、すべてのユーザーがアクセスする必要があるが、特定のプログラムに固有のエイリアスではない場合に便利です。たとえば、MATH 127 や COMSCI 127 などのコースの代替リスティングは、ドメインの名前空間に作成する必要があります。ドメインの名前空間のエイリアスはドメイン管理者のみが作成できますが、ドメイン内のすべてのユーザーに表示されます。
  • デベロッパー プロジェクト: デベロッパー プロジェクトの名前空間は、アプリケーションに固有のエイリアスを管理するのに役立ちます。たとえば、コースに代替 ID を使用するアプリケーションでは、その ID を Classroom コースにマッピングするエイリアスを作成できます。この名前空間で作成されたエイリアスは、特定の Google API Console に関連付けられます。アプリケーションのユーザーは、そのアプリケーションのデベロッパー プロジェクトの名前空間でエイリアスを作成して表示できます。

コースのメタデータとエイリアスの管理について詳しくは、コースを管理するをご覧ください。

コースの名簿とユーザー

生徒と教師は、コースでのユーザーの役割とユーザー プロファイルとコースとの間の具体的なマッピングです。生徒と教師の指定はグローバルではありません。ユーザーが 1 つのコースの教師として割り当てられ、別のコースの生徒として割り当てられる場合があります。「生徒」または「教師」という表記は、特定のコース内の特定のユーザーに対する一連の権限を表します。

受講者
Student リソースは、特定のコースで受講生として登録されているユーザーを表します。受講生は、コースの詳細と講師を閲覧できます。
教師
教師向けのリソースは、特定のコースを教えているユーザーを表します。教師は、コースの詳細の表示と変更、教師と生徒の表示、追加の教師と生徒の管理を行うことができます。

招待とその関連メソッドを使用すると、生徒や教師をコースに簡単に追加できます。招待状を作成すると、教師と生徒のリソースを介して直接招待を追加するのではなく、ユーザーがコースに参加するかどうかを選択できます。

UserProfiles は、Google Admin SDK によって返されたユーザーの一意の ID またはメールアドレスで識別される、ユーザー ドメイン プロファイルへのマッピングを表します。 現在のユーザーは、"me" 短縮形を使用して自分の ID を参照することもできます。

名簿の管理について詳しくは、教師と生徒を管理するをご覧ください。

課題と生徒の提出物

WorkWork は、コースの生徒のグループに割り当てられた単一のタスクを表します。説明、期限、資料などの詳細情報と、作成日時などのメタデータが含まれます。内容としては、タイトル、サムネイル、URL のほか、適切な API(ドライブ、YouTube など)で使用できる識別子などがあります。

CourseWork のアイテムは、次のいずれかのタスクを表します。

  • 生徒がワークシートなどの添付ファイルを提出して完了した課題。
  • 記述式または選択式の問題。

CourseWork 項目に対する生徒の提出物は、StudentSubmission で表されます。 これは、レスポンスと、状態や割り当てられた成績などの追加のメタデータで構成されます。

StudentSubmission の内容は、対応する CourseWork アイテムのタイプによって異なります。

  • 課題のために提出されたワークシートと添付ファイル(タイトル、サムネイル、URL のほか、ドライブや YouTube などの適切な API で使用できる識別子)。
  • 記述式の質問または選択式の質問に対する回答。

コースワークと生徒の提出物の管理について詳しくは、授業を管理するをご覧ください。

始める

環境を設定して API をすぐに使い始めるには、以下のいずれかのクイックスタートをお試しください。

API リファレンスもご覧ください。