【Googleスプレッドシート】Apps Scriptでログを確認する!Logger.log と View > Logs

Apps Scriptでスクリプトを書いていると、変数の値や処理の経過を確認したい場面があります。そんなときに役立つのがLogger.log関数と表示 > ログの機能です。この記事では、Logger.logを使ってログを出力する方法と、出力されたログを表示画面で確認する手順を解説します。これらをマスターすれば、デバッグ作業が格段にスムーズになります。

Logger.logの仕組みとログの保存方法

LoggerオブジェクトはApps Scriptに組み込まれたログ出力専用のオブジェクトです。Logger.log関数を呼び出すと、引数で指定した値がログに出力されます。出力できるデータ型は文字列、数値、ブール値などで、オブジェクトの場合はtoStringメソッドで変換された文字列が出力されます。ログは一時的にGoogleのサーバーに保存され、スクリプトエディタの「表示 > ログ」から確認できます。保存期間は約30日間で、古いものから自動削除されます。また、1回の実行で出力できるログの最大サイズは約500KBです。これを超えると古いログから順に消えていきます。したがって、ループ内で大量のログを出力する場合は注意が必要です。

Logger.logはデバッグの第一歩として非常に便利です。特別な設定は不要で、コード内に1行追加するだけで簡単に使えます。また、ログは実行のたびに新しいセッションとして保存されるため、複数回の実行結果を比較することも可能です。ただし、ログの保存場所はスクリプトエディタ内に限定されており、他のアプリから直接参照することはできません。

Logger.logでログを出力してView > Logsで確認する手順

1. スクリプトエディタを開く
   Googleスプレッドシートを開き、メニューの「拡張機能 > Apps Script」をクリックします。新しいタブでエディタが開きます。
2. 関数を作成する
   デフォルトのmyFunctionに以下のコードを記述します。コードを記述したら「保存」ボタンをクリックしてプロジェクトを保存します。

   function myFunction() {
     Logger.log('Hello, World!');
   }

3. スクリプトを実行する
   ツールバーの「実行」ボタンをクリックするか、関数名を選択して「デバッグ」を押します。初回は権限の承認が必要な場合があります。画面の指示に従って承認を進めてください。
4. ログを表示する
   スクリプトエディタのメニューから「表示 > ログ」を選択します。画面下部にログパネルが開き、実行結果のログが表示されます。今回の例では「Hello, World!」と表示されます。

変数や日時を含むログ出力の例

ログには変数の値や日時を結合して出力することもできます。次のコードは、現在の日時と任意のメッセージを出力する例です。

function logWithDate() {
  var today = new Date();
  Logger.log('現在の日時: ' + today);
  Logger.log('処理が完了しました');
}

このように文字列連結を使って任意の情報をログに出力できます。また、複数の引数をカンマで区切って渡すことも可能ですが、その場合は最初の引数だけがログに出力されるため注意してください。複数の値を出力したい場合は、文字列連結またはテンプレートリテラル(\` バッククォート)を使うと便利です。

スプレッドシートのセル値をログに出力する例

実際の業務では、シート上のデータをログで確認したい場面があります。次のコードはアクティブシートのA1セルの値をログに出力します。

function logCellValue() {
  var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
  var value = sheet.getRange('A1').getValue();
  Logger.log('A1の値: ' + value);
}

これを実行すると、表示 > ログに「A1の値: ○○」と表示されます。ループ内で複数のセルを確認する場合も同様の方法で対応できます。

Logger.logを使う際の注意点とよくあるトラブル

ログが表示されない場合の対処法

スクリプトを実行してもログが表示されない場合があります。その原因として、スクリプトが正常に実行されていない、またはLogger.logの行が実行されていないことが考えられます。実行前に「デバッグ」モードではなく「実行」ボタンを押していることを確認してください。また、条件分岐内にLogger.logを書いた場合、その条件が満たされないと出力されません。関数が正しく呼び出されているか、エラーが発生していないかを確認するために、一度出力を関数の先頭に移動してテストすると良いです。

ログが古くて混乱する場合

View > Logsには過去の実行ログも残っています。現在の実行のログだけを見たい場合は、ログ画面の「Clear」ボタンで一旦クリアしてから再実行すると良いです。また、実行ごとに自動でログが追記されるので、新しい実行のログは一番下に追加されます。ログのタイムスタンプは実行日時で記録されるため、目的の実行を見つける際の目印になります。

大量のログを出力すると古いログが消える

1回の実行で出力できるログの最大サイズは約500KBです。大量のログを出力する場合、古いログから順に消えていきます。そのため、重要な情報は早めに別の場所(たとえばスプレッドシートのセルやファイル)に保存するなどの対策が必要です。ループ処理で毎回ログを出力する場合は、間引いて出力するか、配列にまとめて最後に一度だけ出力する方法を検討してください。

Logger.logとconsole.logの使い分け

Apps ScriptにはLogger.logの他にconsole.logというログ出力方法もあります。console.logはStackdriver Logging(Cloud Logging)にログを出力します。こちらはGoogle Cloud Consoleで詳細なフィルタリングや長期保存が可能ですが、設定が少し複雑です。簡単なデバッグにはLogger.log、本番環境での詳細なログ管理にはconsole.logを使い分けると良いでしょう。

Logger.logとconsole.logの違い

どちらの方法も一長一短あります。Logger.logは手軽さが最大の利点です。console.logは高度な管理が求められる場合に適しています。まずはLogger.logから始めて、必要に応じてconsole.logに移行するとスムーズです。

まとめ:この記事では、Apps ScriptでLogger.logを使ってログを出力し、表示 > ログで確認する方法を解説しました。Logger.logは簡単なデバッグに最適で、スクリプトエディタ内で完結するため手軽です。また、console.logと使い分けることで、より本格的なログ管理が可能になります。まずはLogger.logから試してみて、スクリプトの動作を把握してみてください。日々のスプレッドシート業務でスクリプトを活用する際の強力な味方になるでしょう。