GAS コード書き方

Question

プログラミング超初心者です。

最近GASを触り始めた高校生です。
情報系の部活をしています。学校では授業や課題の提出のためにgoogle classroomを使っています。部活での研究として、「google classroomで配信された課題のうち、未提出のものをGASを用いて取得し、　提出していない人にメールやLINEなどで指定時間に通知するBotを作る」という研究目標を作りました。

ここからが主な質問内容です。
GASでgoogle classroomを操作する練習のためにこちらのサイトでいろいろ試してみようと思いましたが。何をどう書いて実行させればいいのか全くわかりません。
『REST リソース: v1.courses.courseWork』の『list』というメソッドを使ってみたいです。どのようなコードを書けば実行できるのか教えて下さい。

初歩的という域を超えているほど初歩的の質問ですが、教えてくださるとありがたいです。

Answer 1

「GASを用いて」というのが前提であるならば、素のREST APIを使おうとするよりも、Google Apps Scriptにもとから備わっている Classroom サービスを利用した方が楽です。
https://developers.google.com/apps-script/advanced/classroom

Classroom サービスの利用開始準備　

GAS で Classroom サービスを利用するには、下記のようにします。

①エディタの左側のうち、「サービス」のプラス記号をクリックします。


②次に、「Google Classroom API」を選択して、右下の「追加」ボタンをクリックします。


③次に、左側に並んでいる、歯車のアイコンをクリックし「appsscript.json」マニフェスト ファイルをエディタで表示する」にチェックを入れます。


④次に、エディタに戻り、appsscript.jsonファイルを開きます。

そして、appsscript.json に、下記に記載の 「oauthScopes」以降を追加します。

{
  "timeZone": "Asia/Tokyo",
  "dependencies": {
    "enabledAdvancedServices": [
      {
        "userSymbol": "Classroom",
        "version": "v1",
        "serviceId": "classroom"
      }
    ]
  },
  "exceptionLogging": "STACKDRIVER",
  "runtimeVersion": "V8",
  "webapp": {
    "executeAs": "USER_DEPLOYING",
    "access": "ANYONE_ANONYMOUS"
  },
  "oauthScopes": [
    "https://www.googleapis.com/auth/classroom.courses",
    "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
    "https://www.googleapis.com/auth/classroom.profile.emails",
    "https://www.googleapis.com/auth/classroom.profile.photos",
    "https://www.googleapis.com/auth/classroom.rosters",
    "https://www.googleapis.com/auth/classroom.coursework.me",
    "https://www.googleapis.com/auth/classroom.coursework.me.readonly",
    "https://www.googleapis.com/auth/classroom.coursework.students",
    "https://www.googleapis.com/auth/classroom.coursework.students.readonly"
  ]
}

　　
⑤ Ctrl+S（Macの場合はCommand+S）を押してコードを保存します。

---

　

ドキュメントの調べ方について：

Classroomサービスのヘルプ には最低限のことしか記載されていません。

Classroomサービスの各関数は、APIとほぼ１対１対応していますので、
基本的に APIのヘルプを参照し、それをClassroomサービスの各関数の呼び出しに置き換えて実行していくというステップになります。

API と サービスの記述の変換方法については、このドキュメントに書かれているとおりです。

ドキュメント本文やその他ドキュメントに付属のサンプルコードに記載の内容を総合すると

• 『REST リソース: v1.aaa.bbb』の『ccc』というメソッド に対応するGAS上の関数は、 Classroom.Aaa.Bbb.ccc() という形式になる。（先頭は全部「Classroom」で始まり、各階層のオブジェクトは先頭が大文字）
• パスパラメータ（スラッシュで区切って指定するパラメータのこと）は、各関数の引数として指定する（エディタで自動的に候補表示される）。
• クエリパラメータ（「?」以降にパラメータ名を明記して指定するパラメータのこと）は、パラメータ名をプロパティ、パラメータ値を値とするオブジェクトで定義し、関数の引数に指定する。

　
となっています。

これを一般化すると

const クエリパラメータ = {クエリパラメータ名: パラメータの値};
Classroom.Aaa.Bbb.ccc(パスパラメータ, クエリパラメータ);

という書き方になります。

実装の例

まず、自分がアクセス可能なコース名およびコースIDは、下記のようにして取得できます。

function showCourses() {
  const courses = Classroom.Courses.list().courses;
  courses.forEach(course => {
    console.log(`コース名:${course.name}, ID:${course.id}`)
  });
}

(これは Classroom API を扱う際のベースとなるコードですが、なぜこのようなコードになるかについては説明が冗長となるため省略します。とにかくコースIDを取得できないことには始まらないので。このコードを作るまでの調べ方は、基本的には以降に書いてある手順と同じです）

それでは、質問文に記載の「『REST リソース: v1.courses.courseWork』の『list』というメソッド」を使ったコードを、下記のように調べながら実装していきましょう。

ブラウザで、APIドキュメントの左側ガイド一覧より、course.CourseWork -> listを開きます。



ドキュメントの該当部分を見ると
・パスパラメータとして、「courseId」
・クエリパラメータとして、courseWorkStates[]、orderBy、pageSize、pageToken　の4つがあることが分かります。

説明のため、例として、もうすこし具体的な要件を想定してみます。

要件：
自分がアクセスできる各コースごとに、更新時刻降順にコースワークを取得し、それぞれのタイトルと説明文を表示する。

　

「更新時刻降順にコースワークを取得」という処理は、ドキュメントに書いてあるクエリパラメータのうち、orderBy を使用することで実現できそうですね。
（下の図は https://developers.google.com/classroom/reference/rest/v1/courses.courseWork/list#query-parameters より引用）

したがって、第一段階のGASのコードは下記のようになります。
(※下記コードのうち、「コースID」の部分は、実在するアクセス可能なコースIDに置き換えてください）

function showCourseWorks() {
  const params = {orderBy: 'updateTime desc'};  // クエリパラメータ
  const response = Classroom.Courses.CourseWork.list('コースID', params); // 「コースID」は、パスパラメータです。実際にはアクセス可能なコースIDに置き換えてください。
  console.log(response)
}

　

---

これで、正常にデータが取得できていれば、ずらずらっと表示されるはずです。
どのようなデータが入っているかに関しては、ドキュメントの「レスポンス本文」の項目にも書いてあります。

先のページのこの部分によると、レスポンス本文として

{
  "courseWork": [
    {
      object (CourseWork)
    }
  ],
  "nextPageToken": string
}

という形式のデータが返ってくることがわかります。

さらに「CourseWork」オブジェクトの中身を知りたいので、「object (CourseWork)」の青色のリンクをクリックすると、このページ にジャンプします。

これを読むと、title がコースワークのタイトル、description がコースワークの説明文に該当するらしいことがわかります。

したがって先ほどのshowCourseWorks()に、showCourses()の内容と、ループ、 title ／ descriptionを取得する処理を合体して、完成となります。
（※簡便のため、下記のコードは nextPageTokenを使ったページ切替を実装していません。したがってコースワークの合計数によっては、一部のコースワークしか列挙されない場合が有ります）

function showCourseWorks() {
  const courses = Classroom.Courses.list().courses;
  courses.forEach(course => {
    console.log(`コース名:${course.name}, コースID:${course.id}`)
    const params = { orderBy: 'updateTime desc' };
    const response = Classroom.Courses.CourseWork.list(course.id, params);
    const courseWork = response.courseWork;
    if (!courseWork || courseWork.length === 0) {
      console.log('コースワークがないか、有効なコースIDではありません');
      return;
    }
    courseWork.forEach(work => {
      console.log(`タイトル：${work.title}`)
      console.log(`説明：${work.description}`)
    });
  });
}

---

　

基本的に全部公式ドキュメントに書かれていますし、公式ドキュメント以外にも、Classroom APIに関するサンプルコードはたくさん転がっているので、
・ドキュメントをきちんと読む
・いろいろなサイトを検索して実際にコードを書いて実行してみる
の試行錯誤を繰り返しさえすれば、質問者さんのやりたいことはできると思います。

LINE関係の実装も同じです。「ドキュメントを読む／検索して見つけたコードを実際に書いて実行してみて試行錯誤する」の横断を繰り返し。

---

　

開発／運用に関するアドバイス

先生やシステム担当者によって、生徒がGASやREST API経由でアクセスできないように制限されており、コース一覧が表示できなかったり、権限がない（PERMISSION_DENIED）等のエラーが表示される場合が有ります。
そのような場合は、Google Classroomを担当している先生もしくは学校のシステム担当者に相談して、権限を付与してもらう等の対応を行ってください。

なお、いくら「課題提出状況チェックの効率化」という大義名分があるといっても、一生徒に過ぎないあなたが全生徒の課題提出状況にアクセスできてしまうのは、情報管理の観点から問題があるかもしれません。

したがって、開発中は「自分がアクセス可能な情報へのアクセス権限」だけもらい、自分がアクセス可能なデータだけを材料に開発を行う
↓
本番稼働時は（全生徒の課題情報に対してアクセス権限を持っている）先生／システム担当の方で実行してもらう、
といった運用が考えられます。

Comments

[haru_]

返信が遅れてしまったことお詫び申し上げます。

丁寧に説明していただきありがとうございます。qnoirさんの回答を参考にコードを書いてみたらしっかり実行することができました。
ー『REST リソース: v1.aaa.bbb』の『ccc』というメソッド に対応するGAS上の関数は、 Classroom.Aaa.Bbb.ccc() という形式になる。（先頭は全部「Classroom」で始まり、各階層のオブジェクトは先頭が大文字）ー
この部分が特に参考になりました。これで今後使いたいメソッドがあっても実行ができます。

画像とサイトを交えた説明とてもわかり易かったです。改めて感謝申し上げます。ありがとうございます。