概要

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 の教師が、生徒情報システムから情報を同期またはインポートできるようにしたい。	SIS 向け OneRoster を実装するか、Classroom API を使用してリソースを作成してアクセスします。

スタートガイド

新しいデベロッパーは、新しいプロジェクトを開始する前に次のことを行うことをおすすめします。

Classroom API の構造に関するガイドをご覧ください。
グレード、ユーザータイプ、ユーザーの利用資格、管理者による操作をご覧ください。これらのガイドでは、Google Classroom と Classroom API に固有のコンセプトについて説明します。
Classroom API リクエストの仕組みを理解する。

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

Google APIs Explorer を試す

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

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

Classroom API リファレンスを参照することもできます。