【GAS 基礎】Googleカレンダーを操作するCalendarサービス(その２)

Googleカレンダーを操作するCalendarサービス

Calendarサービス

Calandarサービスは、GASでGoogleカレンダーを操作するときに使うクラスとメンバーがまとめられています。Googleカレンダーに登録されたイベントの情報を取得したり、イベントを追加したり削除したりなどの操作が行えます。

Calendarサービスの主なクラス

Calendarサービスのクラスは、CalendarApp→Calendar→CalendarEventという改装構造になっています。これは、スプレッドシートサービスのときの、SpreadsheetApp→Spreadsheet→Sheet→Rangeと同じようにイメージしてもらえればOKです。

前回はその１ということで、CalendarAppクラスについて説明しました。

【GAS 基礎】Googleカレンダーを操作するCalendarサービス(その１)

Googleカレンダーを操作するCalendarサービスCalendarサービスCalandarサービスは、GASでGoogleカレンダーを操作するときに使うクラスとメンバーがまとめられています。Googleカレンダーに登録されたイベントの...

hirachin.com

2020.10.22

今回はその２ということで、Calendarクラスについて説明していきたいと思います。

Calendarクラス

Calendarクラスは前述の通りCalendarサービスの中では第２階層目のクラスになります。上位階層CalendarAppクラスで取得したカレンダーの一つ一つを操作するためのクラスです。

主なメンバーは次です。

上記の通りカレンダー自体に対する操作と、カレンダーに紐づく予定（イベント）を作成するのメソッドがあります。

※実は、Calendarクラスにある、イベントの取得や作成など多くのメソッドは、CalendarAppクラスにもあります。ただし、CalendarAppクラスでのそれらのメソッドは、対象がデフォルトカレンダーになっていますので注意してください。Calendarクラスを利用するほうがより幅広いプログラムが作れると思います。

予定（イベント）を取得する

次のサンプルをGASで取得してみましょう。

上の画像の１０月２８日に予め作った「作った予定１」を取得するサンプルプログラムです。

function test() {
  
  // カレンダーのID(IDはそれぞれ指定してください。)
  var calendarId = "*************@group.calendar.google.com"
  
  // カレンダーを取得する
  var calendar = CalendarApp.getCalendarById(calendarId)
  
  // 指定期間の予定の一覧を取得する
  var startDate = new Date("2020/10/01")　// 取得期間開始日
  var endDate = new Date("2020/10/31")    // 取得期間終了日
  var events = calendar.getEvents(startDate, endDate)　// 予定取得
  
  // ログに書き出す（予定のタイトルを一つずつ書き出す）
  events.forEach(function(event, i , array){
      Logger.log(event.getTitle())　// 作った予定１
  })
}

実行すると、ログに「作った予定１」と表示されます。

予定を取得する方法は、いくつかありますが、ここではgetEventsメソッドを使っています。

取得したい日時の期間を指定できるメソッドです。

他にも、取得したい日を指定するgetEventsForDayメソッドなど色々あります。

オプションを指定することで、細かく条件を指定することが出来ます。

予定（イベント）を作成する

では、GASでカレンダーに予定を追加してみましょう。

予定を新しく追加する場合は、createEventメソッドを使います。

function test() {
  
  // カレンダーのID(IDはそれぞれ指定してください。)
  var calendarId = "*************@group.calendar.google.com"
  
  // カレンダーを取得する
  var calendar = CalendarApp.getCalendarById(calendarId)
  
  // 新しく予定（イベント）を作成する
  var title = "作った予定２"
  var startTime = new Date("2020/10/28 12:00");
  var endTime = new Date("2020/10/28 13:00");
  var options = {
    description: "お金の計算２",
    location: "別荘"
  }
  calendar.createEvent(title, startTime, endTime, options)
  
  
  // 指定期間の予定の一覧を取得する
  var events = calendar.getEventsForDay(new Date("2020/10/28"))
  
  // ログに書き出す（予定のタイトルを一つずつ書き出す）
  events.forEach(function(event, i , array){
      Logger.log(event.getTitle())　// 作った予定１ 作った予定２
  })
}

実行すると、ここで作られた「作った予定２」が追加されているので、「作った予定１」と「作った予定２」がログに表示されます。

引数のオプションの設定は以下のようになっています。

アプリから普通に、Googleカレンダーを作成するときに設定が出来る項目ですね。

まとめ

Calendarクラスの紹介をしました。次回は、CalendarEventクラスについて紹介します！