今回のメソッドは、プログラムを使ってカレンダーイベント(予定)を削除するメソッドを紹介します。
Google Apps Scriptで予定の作成と削除ができるようになれば、CalendarAppの7割くらいは使いこなしていると言ってもいいんじゃないでしょうか?(笑)
冗談ですが、予定の作成/削除ができるようになればおそらくCalendarAppの基本的なところはある程度のことはできるようになっているはずだと思います。
カレンダーイベントを削除するメソッド— deleteEvent()
コピペで使えるサンプルコードを参照したい方はこちらをクリックすればサンプルコードまでジャンプできますので、手っ取り早くコードを確認したい方はクリックしてください。
プログラム的に予定を削除するメソッドは1つしかありませんので、終日予定にも定期予定にも時間指定の予定にも使用することができます。
削除された予定は、ゴミ箱に入れられ、一定期間(30日間)は復元可能な状態で保持されます。間違えて削除してしまった場合でも落ち着いて復元をしてみましょう。
『 引数に入れる値 』
今回のメソッドに関しては引数は必要ありません。
『 関連するメソッド 』
合わせて覚えたいカレンダー予定の操作に関するメソッド
- createEvent — 予定を作成する
- createEventSeries — 繰り返し予定を作成する
- createAllDayEvent — 終日予定を作成する
- createAllDayEventSeries — 繰り返しの終日予定を作成する
- deleteEventSeries — 予定を削除する
deleteEvent()サンプルコード
//予定を削除するコード function sampleCodeForDeleteEvent() { let calendar = CalendarApp.getDefaultCalendar(); let date = new Date(); let events = calendar.getEventsForDay(date); for (let i in events) { let event = events[i]; /*イベントIDで指定するときには下記のコード let eventId = events[i].getId(); let event = calendar.getEventById(eventId); */ event.deleteEvent(); } }
『 変数の説明 』
calendar = デフォルトカレンダーを取得
date = プログラム実行日を代入
events = プログラム実行日に作成済みのイベントを取得
『 予定を削除するサンプルコード 』に上記サンプルスクリプトを記載したスクリプトがあります。
スクリプトができたら▶ボタンでプログラムを実行してみましょう。プログラムが終了すれば実行した日にデフォルトカレンダーに作成済みの予定がすべて削除されてゴミ箱に入れられます。
(削除されたくない予定がある場合は気をつけてください)
まとめ
今回はプログラム的に予定を削除するメソッドを紹介しました。予定の作成と削除を覚えれば、ある程度自由にCalendarAppの操作ができるようになっていると思います。
その他のメソッドについては、作成した予定に対する詳細設定を変更したりするメソッドがほとんどですので、必要に応じて覚えていきましょう。