【GAS入門#43】フォルダ内のファイル一覧を自動取得!Folder.getFiles()とWhileループの完全解説

前回(第42回)は、Folder.createFile() を使って指定した Google ドライブのフォルダ内に「おすすめドライブコース.txt」などの新しいファイルを自動作成する方法を学びましたね!

Google ドライブを GAS で操作できるようになってくると、次にやってみたくなるのが「指定したフォルダの中に、どんなファイルが入っているかを丸ごと一覧にしてスプレッドシートに書き出したい!」という操作です。

たとえば、北海道旅行で撮影した大量の写真ファイルや、業務で溜まった請求書PDF、プレゼン資料などを1つずつ手作業で「ファイル名」や「URL」をコピーしてスプレッドシートに貼り付けるのは、想像するだけで途方もない作業ですよね。

そこで第43回となる今回は、フォルダ内にあるすべてのファイルを一括で探して取り出せる超重要メソッド Folder.getFiles() を徹底解説します!

一見すると少し難しそうに思える「イテレータ(反復処理)」や while ループの仕組みも、身近な例えを使ってどこよりも噛み砕いて説明しますので、ぜひ最後まで一緒に進めていきましょう!

1. そもそも Folder.getFiles() とは?

Folder.getFiles() は、対象のフォルダ(Folder オブジェクト)の中に入っているすべてのファイル群(FileIterator オブジェクト)を取得する命令です。

コードの基本構造

// フォルダ内のファイル一覧(イテレータ)を取得する
var files = folder.getFiles();

ドット(.)のつながりを分解してみると、構造はとてもシンプルです。

  • folder:第41回で学んだ DriveApp.getFolderById() などで取得した対象のフォルダです。
  • .getFiles()(ゲット・ファイルズ):そのフォルダの中にあるファイルを全部まとめて「取り出せる状態」にして呼び出します。末尾に複数形の s がつく点に注目してくださいね!

【超重要】「配列」とは違う!?「イテレータ(Iterator)」のイメージを掴もう!

これまで本連載で扱ってきた「データのまとまり」といえば、第7回で学んだ 配列(Array) でしたよね。配列は [データ1, データ2, データ3] のように、箱の中にデータがズラリと並んでいて、array[0] のように番号を指定すれば好きなデータを取り出せる仕組みでした。

しかし、Folder.getFiles() が返してくれるのは「配列」ではなく、「イテレータ(FileIterator)」 という少し特別な仕組みです。

初心者の方が一番つまずきやすいポイントですので、「回転寿司のレーン」 や 「ガチャガチャ」 に例えてイメージしてみましょう!

概念配列(Array)イテレータ(FileIterator)
例え仕切り付きのお弁当箱回転寿司のレーン / ガチャガチャ
データの状態最初からすべてのデータが見えていて手元にある奥の厨房(ドライブ内)に控えていて、1つずつ流れてくる
取り出し方array[0] や array[1] で直接指指して取る「次はある?」と確認し、1皿ずつ手元に取る
全体の個数array.length で一瞬でわかる最後まで順番に取り出してみるまで全体の個数はわからない

Google ドライブのフォルダ内には、数個のファイルしかないこともあれば、何千個もの巨大なファイルが格納されていることもあります。それらを一気に全部読み込むとパソコンやプログラムがフリーズしてしまうため、GASは「1つずつ順番に取り出せる回転寿司のレーン(イテレータ)」の形で渡してくれるのです。

この「回転寿司レーン」からファイルを取り出すためにペアで使うのが、次の2つの命令です。

  1. files.hasNext()(ハズ・ネクスト):「レーン上に、次のファイル(お皿)は流れてきていますか?」と確認する命令(結果は true か false で返る)。
  2. files.next()(ネクスト):「次のファイル(お皿)を1つ手元に取り出す」命令。

この仕組みさえ理解できれば、Folder.getFiles() はマスターしたも同然ですよ!

2. STEP1:準備!「北海道の風景写真」フォルダとスプレッドシートを用意しよう

それでは、実際に手元の環境でコードを動かす準備をしていきましょう!

今回は「北海道の風景写真フォルダ」からファイル一覧を取得し、スプレッドシートに書き出す実践ワークを行います。

手順

1. Google ドライブに練習用フォルダを作成する

Google ドライブを開き、新しいフォルダを作成します。

  • フォルダ名:北海道の風景写真
  • フォルダの中に、テスト用として適当な画像ファイルやテキストファイルを 3〜5個程度 アップロード(または作成)しておきます。
    • 例:美瑛の青い池.jpg、定山渓の紅葉.png、大通公園の雪景色.jpg など(中身はダミーの画像やファイルで構いません)。

2. フォルダIDを取得する(第41回の復習!)

作成した「北海道の風景写真」フォルダを開き、ブラウザのアドレスバー(URL)を確認します。

https://drive.google.com/drive/folders/ の後ろにある、英数字と記号の長い文字列(例:1a2b3c4d5e6f...)がフォルダIDです。これをコピーしておきましょう。

3. 書き出し用のスプレッドシートを作成する

  1. 新しい Google スプレッドシートを作成し、ファイル名を 北海道写真ファイル一覧 にします。
  2. 1行目(見出し行)に、以下のように項目名を入力しておきます。
    • A1セル:ファイル名
    • B1セル:URL
    • C1セル:最終更新日時

これで準備は完了です!

3. STEP2:【実践】ファイル一覧をスプレッドシートに書き出してみよう!

準備ができたら、スプレッドシートのメニューバーから 「拡張機能」>「Apps Script」 を開き、コードを書いていきましょう。

1. コードを入力する

エディタに元々書いてあるコードをすべて消去し、以下のコードを貼り付けます(YOUR_FOLDER_ID の部分は、先ほどコピーしたご自身のフォルダIDに書き換えてくださいね)。

function listHokkaidoPhotos() {
  // ① 書き込み先のシート(部屋)を取得する
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var sheet = ss.getActiveSheet();
  
  // ② 対象のフォルダ(北海道の風景写真)をIDで取得する
  var folderId = "YOUR_FOLDER_ID"; // ←ご自身のフォルダIDに変更してください
  var folder = DriveApp.getFolderById(folderId);
  
  // ③ フォルダ内のファイル一覧(イテレータ)を取得する
  var files = folder.getFiles();
  
  // ④「次のお皿(ファイル)がある間」ずっと繰り返すループ処理
  while (files.hasNext()) {
    // レーンから次のファイルを1つ取り出す
    var file = files.next();
    
    // ファイルの情報を取り出す
    var fileName = file.getName();       // ファイル名
    var fileUrl = file.getUrl();         // ファイルのWeb URL
    var lastUpdated = file.getLastUpdated(); // 最終更新日時
    
    // 第7回で学んだ appendRow() を使ってシートの末尾に追記する!
    sheet.appendRow([fileName, fileUrl, lastUpdated]);
  }
  
  // ⑤ ログに完了メッセージを出力
  Logger.log("フォルダ内のファイル一覧を正常に書き出しました!");
}

2. コードを1行ずつ丁寧に解説!

初心者向けに、重要なポイントを分解して解説します。

  • var files = folder.getFiles();
    • 指定したフォルダの中からファイル群を呼び出し、「回転寿司レーン(イテレータ)」として変数 files にセットします。この段階ではまだ個々のファイル名などは取れていません。
  • while (files.hasNext()) { ... }
    • while(ホワイル)文は、「条件が true である間、何度でも中の処理を繰り返す」というプログラミングの基本構文です。
    • files.hasNext() が「まだファイルがありますよ(true)」と答えている間、波カッコ { } の中の処理を何度も自動実行します。ファイルがすべて取り出されて空になると false になり、ループが自動的に終了します。
  • var file = files.next();
    • レーンから「次の1つのファイル(File オブジェクト)」を手元に取り出して変数 file に入れます。この file に対して .getName() や .getUrl() を実行することで、ファイル名やリンク先のアドレスを取得できます。
  • sheet.appendRow([fileName, fileUrl, lastUpdated]);
    • 第7回で学んだ超便利メソッドですね!取り出したファイル情報を配列 [ ] にまとめ、スプレッドシートの最終行へサッと1行追記しています。

3. 保存して実行する

  1. エディタ上部の 「保存(フロッピーディスクのアイコン)」 をクリックします。
  2. 実行する関数が listHokkaidoPhotos になっていることを確認し、「実行」 ボタンをクリックします。
  3. 初回実行時は Google ドライブへのアクセス許可(承認プロセス)が表示されますので、第2回で解説した手順で許可を出してください。
  4. スプレッドシートの画面に戻り、結果を確認してみましょう!

【実行結果の確認】

スプレッドシートの2行目以降に、「美瑛の青い池.jpg」などのファイル名、URL、最終更新日時が自動的にズラリと書き出されていれば大成功です!

4. 超重要!while (files.hasNext()) と files.next() の動きを視覚的に理解しよう

while ループの中でイテレータがどう動いているのか、頭の中を整理するためにステップ順で追ってみましょう。

仮にフォルダ内にファイルが 2つ(ファイルA、ファイルB) 入っていたとします。

【スタート時】
レーン上の状態:[ ファイルA ] -> [ ファイルB ]
  1. 1回目の while 判定
    • files.hasNext() ➡ 「次にファイルAがあるよ!(true)」
    • 処理実行:var file = files.next(); ➡ ファイルAを取り出し、シートに書き込む。
  2. 2回目の while 判定
    • files.hasNext() ➡ 「次にファイルBがあるよ!(true)」
    • 処理実行:var file = files.next(); ➡ ファイルBを取り出し、シートに書き込む。
  3. 3回目の while 判定
    • files.hasNext() ➡ 「もうファイルは残っていないよ!(false)」
    • 処理実行:ループを抜けて終了!

このように、ファイルが何十個・何百個あっても、人間が個数をカウントすることなく全自動で最後の1個まで処理してくれるのが while (files.hasNext()) の素晴らしいところです!

5. 初心者が絶対につまずく4大トラップと解決策

Folder.getFiles() と while ループを組み合わせる際、プログラミング初心者が非常に良く遭遇するエラーや失敗パターンを4つ厳選しました。

トラップ1:files.length や files[0] を使おうとしてエラーになる

配列になれている人が一番やってしまうミスです。

// ✕ NGな書き方(イテレータには length や [0] は存在しない!)
Logger.log("ファイルの数: " + files.length); // undefined になる
var firstFile = files[0]; // エラーまたは意図しない動作

【解決策】

イテレータからデータを取り出すときは、必ず while (files.hasNext()) と files.next() の組み合わせを使うと心に刻んでおきましょう!

トラップ2:1回のループ内で files.next() を2回呼び出してしまう

以下のようなコードを書いてしまうと、せっかくのデータが「1つ飛ばし」で処理されてしまいます!

// ✕ NGな書き方(1回のループで2回 next() を呼んでいる)
while (files.hasNext()) {
  Logger.log("ファイル名: " + files.next().getName()); // 1つ目のファイルを取っちゃう
  var url = files.next().getUrl();                     // ★2つ目のファイルを取っちゃう!
}

【解決策】

ループの先頭で var file = files.next(); と書いて1回だけ変数に取り出し、その後はその変数 file を使い回すのが正しい書き方です。

トラップ3:hasNext() のカッコを忘れて無限ループになる

カッコをつけ忘れて files.hasNext と書くと、プログラムが正常に判定できず、無限にループが回り続けて処理が止まらなくなってしまうことがあります。

// ✕ NGな書き方(カッコがない)
while (files.hasNext) { ... }

// ◯ OKな書き方(半角カッコがある)
while (files.hasNext()) { ... }

hasNext() は「状態を確認する命令(メソッド)」ですので、必ず末尾に半角のカッコ () をつけましょう。

トラップ4:ファイルが1つもない空フォルダで実行したらどうなる?

フォルダの中身が完全に空っぽの状態で folder.getFiles() を実行しても、エラーにはなりません。

最初の files.hasNext() の判定でいきなり false になるため、while ループの中身が1回も実行されずに安全に処理がスキップされます。そのため、特別な空欄チェックの処理を書かなくても安心して使えます。

6. 今回のまとめと次回予告

今回は、指定したフォルダ内のファイル一覧を全自動で取得する Folder.getFiles() と、イテレータを扱うための while ループ について解説しました。

今日の重要ポイント

  • Folder.getFiles() は「配列」ではなく「イテレータ(回転寿司レーン)」を返す
  • 「次はある?」の確認には files.hasNext() を使う
  • 「次の1つを取り出す」には files.next() を使う
  • 取り出し処理は while (files.hasNext()) { ... } の定型パターンで書く
  • 1回のループ内で files.next() を複数回呼び出さないよう注意する

これで、Google ドライブ内にバラバラに保存されていたファイル群をスプレッドシートで一括管理・リスト化できるようになりましたね!

さて、ファイルの一覧を取得できるようになると、次は「見つけたテンプレートファイルを自動で複製(コピー)して新しい書類を作りたい!」という自動化がしたくなってきませんか?

次回(第44回)は、ファイルを自由自在に複製できる File.makeCopy() を解説します!

「北海道旅行のレンタカー予約確認書テンプレ」をベースに、プログラムからワンクリックで新しい予約票をコピー作成する実践テクニックを学びましょう。次回もどうぞお楽しみに!