カレンダー予定を繰り返し予定として取得するメソッド— getEventSeries()
CalendarAppのメソッドには繰り返し予定として取得するためのメソッドが2つあります。一つはgetEventSeriesById()で予定のIDから取得する方法です。もう一つは、今回ご紹介するgetEventSeries()です。こちらはEventオブジェクトに対して利用でき、繰り返し予定でなくともEventSeriesオブジェクトとして取得することができます。
EventオブジェクトとEventSeriesオブジェクトはほとんど使えるメソッドが同じため、あまり気にする必要はないかもしれませんが、いくつかそれぞれのオブジェクト特有のメソッドがあるため、使い分けられるようにしておく方が良いと思います。getEventSeries()はEventオブジェクトに対して使用することができ、その予定を繰り返し予定として取得することができるメソッドになります。繰り返し予定として取得すると、deleteEventSeries()やsetRecurrence()などの繰り返し予定特有のメソッドを利用できるようになります。
『 引数に入れる値 』
今回のメソッドに関しては引数は必要ありません。
getEventSeries()
//予定を繰り返し予定として取得するコード function sampleCodeForCalendarAppGetEventSeries1() { var calendar = CalendarApp.getDefaultCalendar(); var date = new Date(); var events = calendar.getEventsForDay(date); for (var i in events) { var eventSeries = events[i].getEventSeries(); console.log(eventSeries); } }
『 変数の説明 』
calendar = デフォルトカレンダーを取得
eventSeries = 繰り返し予定を取得
スクリプトができたら▶ボタンでプログラムを実行してみましょう。今回のサンプルコードでは、プログラム実行日当日の予定を繰り返し予定として取得し、ログで出力するコードを作ってみました。変数eventSeriesには繰り返し予定が取得されますので、ログを確認すると下記スクリーンショットのようにCalendarEventSeriesがログとして出力されます。これはEventSeriesオブジェクトを表していますので、繰り返し予定特有のメソッドが利用できる状態です。
まとめ
今回はEventSeriesオブジェクトを取得するgetEventSeries()について使い方をご紹介しました。それほど難しい使い方ではないので、使い方を頭の片隅に入れておいていただければどこかで活用できると思います。