Google Apps Script のクイックスタート

クイックスタートでは、Google Workspace API を呼び出すアプリを設定して実行する方法について説明します。

Google Workspace のクイックスタートでは、API クライアントライブラリを使用して、認証と承認フローの詳細の一部を処理します。ご自身でアプリを開発する際には、このクライアントライブラリを使用することをおすすめします。このクイックスタートでは、テスト環境に適した簡素な認証方法を使用します。本番環境では、アプリに適したアクセス認証情報を選択する前に、認証と承認について学習することをおすすめします。

Google Classroom API にリクエストを送信する Google Apps Script を作成します。

目標

環境を構成します。
スクリプトを作成して構成します。
スクリプトを実行します。

前提条件

Google Classroom が有効になっている Google for Education アカウント。

Google ドライブへのアクセス

スクリプトを作成する

script.google.com/create に移動して、新しいスクリプトを作成します。
スクリプトエディタの内容を次のコードに置き換えます。

classroom/quickstart/quickstart.gs

GitHub で表示

/**
 * Lists 10 course names and ids.
 */
function listCourses() {
  /**  here pass pageSize Query parameter as argument to get maximum number of result
   * @see https://developers.google.com/classroom/reference/rest/v1/courses/list
   */
  const optionalArgs = {
    pageSize: 10
    // Use other parameter here if needed
  };
  try {
    // call courses.list() method to list the courses in classroom
    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 courses
    for (const course of courses) {
      console.log('%s (%s)', course.name, course.id);
    }
  } catch (err) {
    // TODO (developer)- Handle Courses.list() exception from Classroom API
    // get errors like PERMISSION_DENIED/INVALID_ARGUMENT/NOT_FOUND
    console.log('Failed with error %s', err.message);
  }
}

[保存] をクリックします。
[無題のプロジェクト] をクリックし、[Quickstart] と入力して、[名前を変更] をクリックします。

スクリプトを構成する

Google Classroom API を有効にする

Apps Script プロジェクトを開きます。

[編集者] をクリックします。
[サービス] の横にある [サービスを追加] をクリックします。
Google Classroom API を選択し、[追加] をクリックします。

サンプルの実行

Apps Script エディタで [実行] をクリックします。

サンプルを初めて実行すると、アクセスを承認するよう求められます。

[権限を確認] をクリックします。
アカウントを選択してください。
[許可] をクリックします。

スクリプトの実行ログがウィンドウの下部に表示されます。

次のステップ

Java