Classroom サービス

コースと名簿を管理する。

Classroom サービスを使用すると、Google Apps Script で Google Classroom API を使用できます。この API を使用すると、管理者、教師、生徒はコースと名簿を表示して管理できます。

これは、使用前に有効にする必要がある拡張サービスです。開始手順については、クイックスタートをご覧ください。

リファレンス

このサービスの詳細については、Classroom API のリファレンス ドキュメントをご覧ください。Apps Script のすべての高度なサービスと同様に、Classroom サービスでは、公開 API と同じオブジェクト、メソッド、パラメータを使用します。詳細については、メソッドのシグネチャの決定方法をご覧ください。

問題を報告したり、その他のサポートを利用したりするには、Classroom に関するサポートガイドをご覧ください。

サンプルコード

次のサンプルコードでは、API のバージョン 1 を使用しています。

コースを一覧表示する

このサンプルでは、ユーザーがアクセスできる最初の 10 個のコースを一覧表示します。

advanced/classroom.gs
/**
 * Lists 10 course names and IDs.
 */
function listCourses() {
  /**
   * @see https://developers.google.com/classroom/reference/rest/v1/courses/list
   */
  const optionalArgs = {
    pageSize: 10,
    // Use other query parameters here if needed.
  };
  try {
    const response = Classroom.Courses.list(optionalArgs);
    const courses = response.courses;
    if (!courses || courses.length === 0) {
      console.log("No courses found.");
      return;
    }
    // Print the course names and IDs of the available courses.
    for (const course in courses) {
      console.log("%s (%s)", courses[course].name, courses[course].id);
    }
  } catch (err) {
    // TODO (developer)- Handle Courses.list() exception from Classroom API
    console.log("Failed with error %s", err.message);
  }
}