今回から、いよいよ新しいフェーズである「フェーズ8:Googleカレンダー連携編(第76回〜第80回)」に突入します!
Googleカレンダーの操作をマスターすると、以下のような業務効率化が実現できるようになります。
- スプレッドシートの研修日程一覧から、Googleカレンダーへ予定を一括自動登録する
- 「札幌オフィス第1会議室」の空き状況や予約重複をGASで一瞬でチェックする
- 決まったメンバーへ会議の招待状(ゲスト招待)を自動送信する
- 過去の不要なミーティング予定や旧スケジュールを自動で一括削除・整理する
その記念すべき第76回で学習するのが、目的のカレンダーをピンポイントで取得する基本中の基本命令 CalendarApp.getCalendarById() です!
今回は、「そもそもサブカレンダーとは何か?」という疑問に応えるサブカレンダーの作成手順から、GASで指定するために必要な「カレンダーID」の調べ方、実際のコードによる情報取得、そして初心者がハマりやすい落とし穴まで、どこよりも分かりやすく徹底解説していきます!
1. そもそも CalendarApp.getCalendarById() とは?
CalendarApp.getCalendarById() は、指定した「カレンダーID」をもとに、操作したい特定のGoogleカレンダー(Calendarオブジェクト)を取得するための命令(メソッド)です。
コードの基本構造を分解してみよう
var calendar = CalendarApp.getCalendarById("カレンダーID");
CalendarApp(カレンダー・アップ)
Googleカレンダーに関する機能をまとめて管理している親玉(クラス)です。GASに対して「今からGoogleカレンダーの操作をするよ!」と宣言する役割を果たします。.getCalendarById("〜")(ゲット・カレンダー・バイ・アイディ)CalendarAppという親玉に対する命令(メソッド)です。カッコの中に指定した「カレンダーID」と一致するカレンダーを探して連れてきます。
「getDefaultCalendar()」と「getCalendarById()」の違い
GASでGoogleカレンダーを取得する命令には、主に以下の2種類が存在します。
| メソッド名 | 役割 | 現実世界での例え |
CalendarApp.getDefaultCalendar() | ログインしているユーザーの**メインカレンダー(個人用)**を取得する | 自分のポケットに入っている個人用システム手帳 |
CalendarApp.getCalendarById("ID") | IDで指定した**特定のカレンダー(サブカレンダーや共有カレンダー)**を取得する | 会社の壁に掛けてある会議室の予約表やチーム共有ホワイトボード |
なぜ getCalendarById() が実務で必須なの?
「自分の個人カレンダー(デフォルトカレンダー)に予定を入れられれば十分では?」と思うかもしれません。
しかし実務では、個人カレンダーとは別に「札幌オフィス第1会議室カレンダー」や「全社イベント共有カレンダー」、「プロジェクト専用カレンダー」といった「サブカレンダー」や「共有カレンダー」を運用・操作するケースが大半です。
自分のプライベートな予定と仕事の会議室予約が混ざってしまうのを防ぎ、特定のチームや部屋のスケジュールだけをピンポイントで自動化するためには、この getCalendarById() が欠かせないのです!
2. 超初心者向け!まずは「サブカレンダー」を作ってみよう
getCalendarById() を試す前に、まずは実験台となる「サブカレンダー」をGoogleカレンダーの画面上で新しく作成してみましょう。
「サブカレンダー」とは、自分メインのアカウント内に作成できる追加の専用カレンダーのことです。用途別にカレンダーを分けることで、色の塗り分けや表示・非表示の切り替え、他人との共有が簡単になります。
今回は、北海道ネタとして「札幌オフィス第1会議室」という名前のサブカレンダーを作成してみます!
サブカレンダー作成のステップ・バイ・ステップ手順
STEP 1:Googleカレンダーを開く
パソコンのブラウザ(Google Chromeなど)で Googleカレンダー を開きます。
STEP 2:「他のカレンダー」の「+」ボタンを押す
画面左側のサイドバーを下へスクロールすると、「他のカレンダー」 という項目があります。その横にある 「+(他のカレンダーを追加)」 マークをクリックします。
【画面イメージ】
他のカレンダー [+] ←ここをクリック!
STEP 3:「新しいカレンダーを作成」を選択する
出てきたメニューの中から 「新しいカレンダーを作成」 をクリックします。
STEP 4:カレンダーの情報を入力する
カレンダーの設定画面が開いたら、以下の項目を入力します。
- 名前:
札幌オフィス第1会議室 - 説明(任意):
札幌オフィスの打ち合わせ・ミーティング用会議室カレンダー - タイムゾーン:
(GMT+09:00) 日本標準時 - 東京
STEP 5:「カレンダーを作成」をクリックする
入力が完了したら、下部にある青い 「カレンダーを作成」 ボタンをクリックします。数秒待つと画面下部に「〜が正常に作成されました」と表示されます。
画面左上の「←(戻る矢印)」を押してメイン画面に戻ると、左側のカレンダー一覧に今作った 「札幌オフィス第1会議室」 が追加されています!
3. 超重要!「カレンダーID」の調べ方・確認手順
サブカレンダーが作成できたら、次はそのカレンダーをGASから指定するための住所にあたる「カレンダーID」を確認しましょう。
GASプログラムは「札幌オフィス第1会議室」という日本語の名称ではなく、Google内部で管理されている一意の英数字コード(カレンダーID)を使って識別します。
カレンダーID確認の4ステップ
STEP 1:カレンダーのオプションメニューを開く
Googleカレンダーの左側一覧から、作成した 「札幌オフィス第1会議室」 にマウスカーソルを合わせます。右側に表示される 「縦の3点リーダー(⋮)」 をクリックします。
STEP 2:「設定と共有」を開く
メニューが表示されるので、「設定と共有」 をクリックします。
STEP 3:「カレンダーの統合」項目を探す
設定画面が開いたら、左側メニューの 「カレンダーの統合」 をクリックするか、画面を一番下までスクロールします。
STEP 4:「カレンダー ID」をコピーする
「カレンダーの統合」セクション内に、「カレンダー ID」 という項目があります。
ここに表示されている文字列が、このカレンダー専用のIDです!
【カレンダーIDの表示例】
・サブカレンダーの場合:
xxxxxxxxxxxxxxxxxxxxxxxxxx@group.calendar.google.com
・自分のメインカレンダーの場合:
your-name@gmail.com(ご自身のGoogleメールアドレス)
この @group.calendar.google.com が含まれる長い文字列を丸ごとコピーしておきましょう!
4. STEP1:【実践】「札幌オフィス第1会議室」カレンダーを取得してGASで確認しよう!
カレンダーIDが準備できたら、いよいよGASのエディタを開いてプログラムを書いていきましょう!
今回は、取得した「札幌オフィス第1会議室カレンダー」から、カレンダー名、タイムゾーン、説明文を取得してログ画面に出力してみます。
1. スプレッドシートとGASエディタを開く
- 新しいGoogleスプレッドシートを作成し、タイトルを 「札幌オフィス設備管理簿」 にします。
- 上部メニューバーの 「拡張機能」 > 「Apps Script」 をクリックしてGASエディタを開きます。
2. コードを入力する
エディタ画面に元々書かれている function myFunction() { ... } をすべて消去し、以下のコードをコピー&ペーストしてください。
※ var roomCalendarId = "..." の部分には、先ほどコピーしたご自身のサブカレンダーIDを貼り付けてください!
/**
* 第76回:CalendarApp.getCalendarById() の基本動作確認スクリプト
* 「札幌オフィス第1会議室カレンダー」を指定して情報を取得します。
*/
function getSapporoRoomCalendar() {
// ① 操作したいカレンダーの「カレンダーID」を準備する(ご自身のIDに置き換えてください)
var roomCalendarId = "xxxxxxxxxxxxxxxxxxxxxxxxxx@group.calendar.google.com";
// ② CalendarApp.getCalendarById() を使って目的のカレンダー(Calendarオブジェクト)を取得する
var targetCalendar = CalendarApp.getCalendarById(roomCalendarId);
// ③【安全対策】カレンダーが正常に取得できたかをチェックする(nullチェック)
if (targetCalendar === null) {
Logger.log("【エラー】指定されたカレンダーIDが見つからないか、アクセス権限がありません。");
Logger.log("カレンダーID:「" + roomCalendarId + "」を再確認してください。");
return; // 処理をここで中断する
}
// ④ 取得したカレンダーオブジェクトから各種情報を引き出す
var calendarName = targetCalendar.getName(); // カレンダー名を取得
var timeZone = targetCalendar.getTimeZone(); // タイムゾーンを取得
var description = targetCalendar.getDescription(); // カレンダーの説明を取得
// ⑤ 第1回で学んだ Logger.log() で実行ログに出力する!
Logger.log("==========================================");
Logger.log("■ カレンダーの取得に成功しました!");
Logger.log("・カレンダー名 : " + calendarName);
Logger.log("・タイムゾーン : " + timeZone);
Logger.log("・説明文 : " + description);
Logger.log("==========================================");
}
3. コードのポイントを1行ずつ丁寧解説!
var roomCalendarId = "..."
取得したいカレンダーIDを変数に格納しています。文字列なので必ず""(ダブルクォーテーション)で囲みましょう。CalendarApp.getCalendarById(roomCalendarId)
本日の主役です!指定したIDのカレンダーを探しに行き、見つかればCalendarオブジェクトを変数targetCalendarに代入します。if (targetCalendar === null)
もしIDの間違いや権限不足でカレンダーが取得できなかった場合、getCalendarById()はnull(ヌル:空っぽという意味) を返します。nullのまま次の処理に進むとエラーで停止するため、このif文でガードしています。targetCalendar.getName()
取得したカレンダーの表示名(例:「札幌オフィス第1会議室」)を取り出す命令です。targetCalendar.getTimeZone()
カレンダーに設定されているタイムゾーン(例:「Asia/Tokyo」)を取得します。targetCalendar.getDescription()
カレンダーの設定画面で入力した説明文を取得します。
4. 初回実行とアクセス承認(権限の許可)
コードが入力できたら、上部の 「保存(フロッピーディスクマーク)」 を押し、関数が getSapporoRoomCalendar になっていることを確認して 「実行」 をクリックします。
初めてGoogleカレンダーを操作するGASを実行すると、第2回でも体験した「承認が必要です」 というセキュリティ画面が表示されます。
承認の手順(復習)
- 「権限を確認」 ボタンをクリックします。
- ご自身のGoogleアカウントを選択します。
- 「このアプリは Google で検証されていません」と表示されたら、左下の 「詳細」 をクリックします。
- 下部に現れる 「無題のプロジェクト(安全ではないページ)に移動)」 をクリックします。
- 最後に 「許可」 をクリックします。
5. 実行結果を確認してみよう!
承認完了後、自動的にプログラムが実行されます。エディタ下部の「実行ログ」に以下のように出力されれば大成功です!
情報 ==========================================
情報 ■ カレンダーの取得に成功しました!
情報 ・カレンダー名 : 札幌オフィス第1会議室
情報 ・タイムゾーン : Asia/Tokyo
情報 ・説明文 : 札幌オフィスの打ち合わせ・ミーティング用会議室カレンダー
情報 ==========================================
GASがカレンダーIDを認識し、「札幌オフィス第1会議室」というカレンダーの情報を正しく引き出してくれました!
5. 初心者が絶対につまずく!5大トラップと解決策
getCalendarById() を使用する際、プログラミング初心者やGAS学習者が非常によく遭遇するエラーやトラブルを5つ厳選しました。あらかじめ対処法を知っておくことで、無用なトラブルで悩まずに済みますよ!
トラップ 1:IDではなく「カレンダー名」を指定してしまう
✕ NGな書き方
// カレンダーの名前(日本語)をそのまま書いてしまう
var calendar = CalendarApp.getCalendarById("札幌オフィス第1会議室");
◯ OKな書き方
// 必ず @group.calendar.google.com などが含まれるカレンダーIDを書く
var calendar = CalendarApp.getCalendarById("xxxxxxxxxx@group.calendar.google.com");
getCalendarById() の「Id」は、画面上の表示名ではなく設定画面で確認した英数字のカレンダーIDを意味します。カレンダー名を入れて実行すると、カレンダーが見つからず結果が null になってしまいます。
トラップ 2:コピーしたIDの前後に「不要なスペース」が入っている
設定画面からIDをコピー&ペーストした際、誤って末尾や先頭に半角スペースや全角スペースが混入してしまうケースが多発します。
// ✕ IDの末尾にスペースが入っている(見た目では分かりにくい!)
var calendar = CalendarApp.getCalendarById("xxxxxxxxxx@group.calendar.google.com ");
スペースが1文字でも入っていると、Googleは「別の存在しないID」と判断して取得に失敗します。コピペした後は引用符 " " の中に余計な空白が含まれていないかチェックしましょう!
トラップ 3:アクセス権限(共有設定)がないカレンダーIDを指定している
他人の個人用カレンダーID(例:colleague@gmail.com)や、自分に閲覧権限が与えられていない他部署の社内カレンダーIDを指定しても、GASはセキュリティ上そのカレンダーを取得できません(null が返されます)。
操作したいカレンダーが共有カレンダーの場合は、事前にGoogleカレンダーの「設定と共有」から、自分のアカウントに対して「予定の変更権限」または「閲覧権限」が共有されているか確認してください。
トラップ 4:TypeError: Cannot read properties of null (reading ‘getName’)
実行時に赤文字で以下のようなエラーが発生することがあります。
TypeError: Cannot read properties of null (reading 'getName')
原因
CalendarApp.getCalendarById() の段階でカレンダーが見つからず null になったにもかかわらず、そのまま null.getName() を実行しようとしたために発生するエラーです。
解決策
実践コードでも取り入れたように、if (targetCalendar === null) によるガード処理(nullチェック)を必ず書きましょう!
var targetCalendar = CalendarApp.getCalendarById(roomCalendarId);
if (targetCalendar === null) {
Logger.log("カレンダーの取得に失敗しました。IDを確認してください。");
return; // 処理を安全に終了させる
}
トラップ 5:スタンドアロンスクリプトで実行してアクセスをブロックされる
Googleドライブの「新規」>「Google Apps Script」から作成した独立型のGAS(スタンドアロンスクリプト)でカレンダー操作を行う場合、対象のカレンダーへアクセス権限がないとエラーになりやすいです。
慣れないうちは、操作管理用スプレッドシートの「拡張機能」>「Apps Script」(コンテナバインドスクリプト)から作成・実行するのが最も安全で確実です。
6. 実務での活用イメージと応用例
今回学んだ CalendarApp.getCalendarById() は、単体で使うだけでなく、今後学ぶさまざまな操作の起点となります。
具体的に実務でどのように活用されていくのか、イメージを膨らませてみましょう!
【実務での自動化フロー例】
[スプレッドシート: 札幌オフィス会議室予約一覧表]
│
▼ (1) シートから「日時」「会議名」「担当者」を読み取る
[GASプログラム]
│
▼ (2) CalendarApp.getCalendarById("第1会議室ID") で部屋を指定!
[札幌オフィス第1会議室カレンダー]
│
▼ (3) Calendar.createEvent() でカレンダーに自動追加!
[Googleカレンダーに予定が反映される!]
- 会議室予約の重複防止システム
スプレッドシートの予約フォームに送信があった際、getCalendarById()で「札幌オフィス第1会議室」を取得し、指定の時間帯にすでに他の予約が入っていないかをチェックする。 - プロジェクトスケジュールの自動同期
スプレッドシートにまとめた「システム開発マイルストーン」の表から、プロジェクト共有カレンダーを取得して一括でスケジュール登録する。 - シフト表からの個人カレンダーへの反映
アルバイトや社員のシフト表データから、個人のIDを指定してそれぞれのカレンダーへ勤務予定を書き込む。
7. 今回のまとめ&次回予告
今回は、特定のGoogleカレンダーを取得する超基本命令 CalendarApp.getCalendarById() について徹底解説しました!
本日の重要ポイントおさらい
CalendarApp.getCalendarById("ID")は、指定したIDのカレンダーを取得する命令- 個人のメインカレンダーだけでなく、会議室やプロジェクト用のサブカレンダー・共有カレンダーの操作に必須
- カレンダーIDはGoogleカレンダーの「設定と共有」>「カレンダーの統合」から確認する
- 指定するのは日本語のカレンダー名ではなく、
@group.calendar.google.comなどのID文字列 - 取得失敗時のエラーを防ぐため、必ず
if (targetCalendar === null)のチェックを入れる
カレンダーオブジェクトという「目的の予約表(カレンダー)」をGASで掴むことができたので、次はいよいよそのカレンダーの上に新しい予定(イベント)を自動で書き込む操作にチャレンジしましょう!
次回は、Calendar.createEvent() / createAllDayEvent() をお届けします!
「札幌オフィス第1会議室」に、日時を指定した会議の予定や、終日のイベントをプログラムから一瞬で書き込むテクニックを学びます。ぜひ楽しみに待っていてくださいね!
