概要

Google Classroom API は、ソフトウェア デベロッパー、管理者、学校のリーダーが Google Classroom リソースを管理するためのプログラミング インターフェースを提供します。Classroom のコースとそのコンテンツを作成、取得、変更するソフトウェアを構築できます。

一般的なユースケースは次のとおりです。

  • コース、名簿、保護者の管理
  • 課題、お知らせ、コース資料の追加
  • 成績の割り当てと成績設定の変更
  • 分析用データの生成
  • Classroom 内で外部プロバイダのコンテンツやツールを見つけてアクセス可能にする

Classroom API が最適なソリューションか

Google は、Classroom の操作に役立ついくつかのプロダクトを提供しています。以下に、一般的なシナリオと、ニーズに最適なプロダクトの推奨事項を示します。

Google Classroom リソースを変更する

シナリオ おすすめのソリューション
大量のコース、ユーザー、その他の Classroom リソースを定期的に管理したいですコードの記述とソフトウェア インフラストラクチャのメンテナンスをストレスフリーにしています。 Classroom API を使用するアプリケーションを作成します。
少量の Classroom リソースを 時々管理したいと思っていますオーバーヘッドが少なく、少量のコードを記述することに慣れている。 Google Apps Script で Classroom API を使用します。
個々の Classroom リソースに 変更を加えたいと考えていますターミナル コマンドは問題なく操作できます。 Google Apps Manager を使用します。
Classroom のイベントの詳細を含む大量のレポートを作成したい。 BigQuery Data Transfer Service を使用します。
ユーザーのアクティビティを調査したい。 管理コンソールでレポートを生成するか、Reports API を使用します。

Google Classroom と統合する

シナリオ おすすめのソリューション
教師と生徒が Classroom でコンテンツを表示して起動できるようにしたい。 Classroom アドオンを作成する。
教師がウェブサイトまたはアプリのボタンをクリックして、コンテンツを Classroom に埋め込むようにしたい。 Classroom アドオンを作成し、プログラムで添付ファイルを作成する。
ウェブサイトやアプリのボタンをクリックして Classroom のコンテンツにリンクさせたいのですが Classroom API を使用して課題を作成するか、Classroom に共有ボタンを埋め込みます。
Classroom の教師が生徒情報システムと情報を同期またはインポートできるようにしたい。 OneRoster for SIS を実装するか、Classroom API を使用してリソースを作成し、アクセスできます。

スタートガイド

新しいプロジェクトを開始する前に、次の作業を行うことをおすすめします。

開発を開始するには、前提条件の手順が完了していることを確認してください。ニーズに応じて適切な Classroom API スコープを選択し、環境を設定して、次のいずれかのクイックスタートに沿ってリクエストを開始します。

Google APIs Explorer でテストする

ライブデータで呼び出しメソッドをテストするには、Google APIs Explorer を使用してください。使用を開始するためにコードを記述する必要はありませんが、API Explorer を使用して実行するアクションによって既存のデータが変更される可能性があることに注意してください。

メソッドの呼び出しを開始する方法の一つは、courses.list() メソッドを呼び出すことです。このメソッドではリクエスト パラメータは必要ありません。返されたコースのリストから id を取得して、他の API 呼び出しのリクエスト パラメータとして使用できます。コースがない場合は、courses.create() メソッドを使用してコースを作成できます。

Classroom API リファレンスも参照してください。