【コピペで使える】GASで繰返し予定を削除してみる

カレンダーの定期予定を削除するメソッド— deleteEventSeries()

今回のメソッドは、プログラムを使ってカレンダーの定期予定を削除するメソッドを紹介します。

以前ブログラムでカレンダーの予定を削除するメソッドとしてdeleteEvent()をご紹介しました。deleteEvent()メソッドでは、予定のタイプ（終日や定期、時間指定等）に関わらずすべての予定に対して実行できるメソッドでした。今回は、定期予定を削除するためのdeleteEventSeries()メソッドをご紹介します。このメソッドを利用すれば、定期予定を一括で削除することができます。deleteEventで定期予定を削除する場合は一つずつ削除する必要がありますが、deleteEventSeriesを使えば一気に関連する定期予定を削除することができます。

1. 1. deleteEventSeries()

削除された予定は、ゴミ箱に入れられ、一定期間（３０日間）は復元可能な状態で保持されます。間違えて削除してしまった場合でも落ち着いて復元をしてみましょう。

『 引数に入れる値 』

今回のメソッドに関しては引数は必要ありません。

deleteEventSeries()

//定期予定を削除するコード
function sampleCode1ForCalendarAppDeleteEventSeries() {
  var calendar = CalendarApp.getDefaultCalendar();
  var event = calendar.getEventSeriesById(""); //定期予定のイベントIDを設定します。
  event.deleteEventSeries();
}

『 変数の説明 』

calendar = デフォルトカレンダーを取得
event = 定期予定を取得

スクリプトができたら▶ボタンでプログラムを実行してみましょう。実行前にイベントIDを設定することを忘れないで下さい。プログラムが終了すれば指定したイベントIDの定期予定を削除することができます。イベントIDの取得はプログラムから実行するしか取得する方法はありませんので、こちらの記事を参照してIDを取得してみて下さい。

まとめ

今回はプログラム的に定期予定を一括で削除するメソッドを紹介しました。使い方はdeleteEvent()メソッドと同じですが、定期予定に対してしか使用することができない点に注意して下さい。通常の予定に対して実行しようとするとエラーになります。