Google Apps Scriptでファイルフォルダの探索【GAS】
外部DBがない環境の場合、スプレッドシートのみが唯一のデータ蓄積場所になるわけなのですが、例えば各支店に同じスプレッドシートに書かせるというのは、色々と不安な面があるだけでなく、見せたくないという要望もあったりします。となると、スプレッドシートを各支店別に用意して記入してもらい、本店はそれを収集する事になるわけですが、いちいち支店のスプレッドシートを開いてコピペでは非生産的です。となると、これらのファイルをリスト化し、そのリストを元にスクリプトでデータ収集が王道になると思います。
そこで必要になるのが今回のテクなのですが、自分もfilelistというシートにボタン一発で指定のスプレッドシートのIDを指定フォルダ内から収集し、filelistを元にデータを集めるスクリプトを常用しています。filelistの構築を主に例としてコードを紹介していきます。これには、指定フォルダ以下のサブフォルダ内のスプレッドシート全てを見に行くようになっているので、あまりGoogle Driveで深い階層を作ると後にこういうスクリプトを回す上で問題になるので、なるべく浅く作ることと、Google Driveはシンボリックリンク的に同一ファイルを別のフォルダにも配置が出来るので、それを利用するのもスピードアップに効果的ですよ。
目次
今回使用するスプレッドシート等
Google Driveの特徴
Google DriveとそのAPIの特徴として、以下の点が挙げられます。
- ディレクトリという概念があるわけじゃない。あくまでも、人間がわかりやすい形で、ディレクトリツリー構造のようなインターフェースになっているだけで、すべてのファイルがルートディレクトリに存在している状態を思い浮かべると良い。
- 特定のディレクトリに属しているという情報をファイルが持っている。
- keyで管理されているため、同じファイル名の同じファイルが同じレベルで存在することが出来る。
- 検索をする際に、サブディレクトリまで精査してくれない。
- 細かく検索条件を設定できるものの、ちょっといまいちな点も多い。
- DriveAppとDocsListの２つの同じようなクラスがありましたが、DocsListは廃止されました。
- 現在、フォルダ単位でのコピーが出来ない。
こんな感じです。
WindowsやmacOSのようなOS上でのファイルの検索とは少々異なる点があるため、正直な所、決して使いやすいわけではない。しかし、複数のファイルのkeyを知る必要性があるようなケースでは、必須のテクニックであり、そこで得たkeyのデータを元に、データを取りに行くなどのコードを書くことになるわけです。
ファイルやフォルダを別のフォルダにも所属させる
※この機能は、2022年ショートカットの作成機能によって廃止されました。よってシンボリックリンクのように複数のパスに所属といったことが出来なくなりました。
Google Driveには、UNIXで言うところの「シンボリックリンク」のような機能が実はあります。普通のファイルサーバではちょっと見かけないものですが、１つのファイルやフォルダを複数のフォルダに所属させる事が可能です。どちらも実体でありショートカットではありません。ファイルのアクセス権限が複雑になったりするので、取扱い注意の機能ですが、今回のようにあちこちに散らばってる同じようなファイルを、１箇所のフォルダに集めるにはもってこいの機能です。
やり方は簡単
- ファイルやフォルダを選択する
- Shift + Zキーを押す（その他のショートカットキーはこちらを参照）
- メニューが出てくるので、所属先まで行き「ここに追加」を選択する
- 同一のフォルダやフォルダが別の場所にも表示されるようになる
図：どちらも実体を表しています。
また、この作業をしたファイルがどこのフォルダに所属しているのか？また、所属の解除も簡単です。
- そのファイルやフォルダを選択する
- 右上にある（i）のボタンをクリックしてファイル情報のサイドバーを表示
- サイドバーの詳細タブをクリックする
- パスの項目に所属先一覧が出てくる。☓印をクリックすると、所属の解除ができる
図：所属先一覧も簡単に確認できます。
ソースコード
単一のフォルダ内のファイルを列挙する
var folderid = "ここに探索先フォルダのIDを入れる"
function driveman(){
//Drive APIで特定のファイルをリストとして取得
var key = folderid;
var files = DriveApp.searchFiles("mimeType = 'application/vnd.google-apps.spreadsheet' and '"+key+"' in parents");
//filelistシートに移動し内容をクリアする
var mvsheet = SpreadsheetApp.getActiveSpreadsheet();
mvsheet.getSheetByName("filelist").activate();
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A2:B").clearContent();
//まずカレントディレクトリ内のファイルリストの書き込み
var Cell = SpreadsheetApp.getActiveSheet().getRange("A2");//offsetの参照点セルを設定
Cell.activate();
var i = 0;
while(files.hasNext()){
var file = files.next();
Cell.offset(i, 0).setValue(file.getId());
Cell.offset(i, 1).setValue(file.getName());
i++;
}
//次にフォルダがあるか検索し、あった場合にはフォルダリスト配列に格納する
var folderlist = new Array();
var folders = DriveApp.searchFolders("'"+key+"' in parents");
var j = 0;
while (folders.hasNext()) {
var folder = folders.next();
folderlist[j] = folder.getId();
j++;
}
//フォルダリストに基づき、各フォルダキーの中のファイルを書き出していく
for(var xx = 0;xx<folderlist.length;xx++){
var curFolder = folderlist[xx];
files = DriveApp.searchFiles("mimeType = 'application/vnd.google-apps.spreadsheet' and '"+curFolder+"' in parents");
while(files.hasNext()){
var file = files.next();
Cell.offset(i, 0).setValue(file.getName());
Cell.offset(i, 1).setValue(file.getId());
i++;
}
}
}
- 今回は、folderidに検索対象のフォルダのIDを予め、入れておいてあるので、これを元にフォルダの探索を実行し、ファイルのIDを列挙させています。
- Drive.searchFilesではmimeTypeにてGoogleスプレッドシートを条件に指定していますので、他のファイルはヒットしないようになっています。
サブフォルダまで含めてファイルを探索するコード
//サブフォルダまで含めてファイル探索するコード
function driveman2(){
var ui = SpreadsheetApp.getUi();
var mvsheet = SpreadsheetApp.getActiveSpreadsheet();
//指定フォルダから探索開始
//var str = DriveApp.getRootFolder().getId(); //ルートフォルダから探索する場合
var str = folderid;
//Drive APIで特定のファイルをリストとして取得
var key = str;
var nowdir = key;
var totalcount=0;
//filelistシートに移動し内容をクリアする
var sheet = mvsheet.getSheetByName("filelist");
sheet.activate();
sheet.getRange("A2:B").clearContent();
//フラグ類
var subfolderflag = 0; //1なら有り、0なら無し。
//次にフォルダがあるか検索し、あった場合にはフォルダリスト配列に格納する
var folderlist = new Array();
var filelist = new Array();
var folders = DriveApp.searchFolders("'"+key+"' in parents");
var cntlist = 0;
if(folders.length == 0){
//普通に指定フォルダ内のファイルのリストを書き出して終了
var files = DriveApp.searchFiles("mimeType = 'application/vnd.google-apps.spreadsheet' and '"+key+"' in parents");
while(files.hasNext()){
var fileman = files.next();
var temparray = [];
temparray.push(fileman.getId());
temparray.push(fileman.getName());
filelist.push(temparray);
cntlist = cntlist + 1;
}
//プロシージャの終了
return 0;
}else{
//サブフォルダフラグを立てる
subfolderflag=1;
//指定フォルダ内のファイルのリストを書き出す
var files = DriveApp.searchFiles("mimeType = 'application/vnd.google-apps.spreadsheet' and '"+key+"' in parents");
while(files.hasNext()){
var fileman = files.next();
var temparray = [];
temparray.push(fileman.getId());
temparray.push(fileman.getName());
filelist.push(temparray);
cntlist = cntlist + 1;
}
//フォルダリスト配列に格納する
while(folders.hasNext()){
var folder = folders.next();
folderlist.push(folder.getId());
}
}
//サブフォルダ以降のフォルダの探索ルーチン
while (subfolderflag == 1) {
var nowponyo = folderlist.length;
for(var i = 0;i<nowponyo;i++){
//0番目の配列のkeyを取得する
key = folderlist[0];
//指定フォルダ内のファイルのリストを書き出す
files = DriveApp.searchFiles("mimeType = 'application/vnd.google-apps.spreadsheet' and '"+key+"' in parents");
while(files.hasNext()){
fileman = files.next();
var temparray = [];
temparray.push(fileman.getId());
temparray.push(fileman.getName());
filelist.push(temparray);
cntlist = cntlist + 1;
}
//そのkeyのフォルダにぶら下がるフォルダをリストアップ
folders = DriveApp.searchFolders("'"+key+"' in parents");
nowdir = key;
//フォルダリスト配列に格納する
if(folders.hasNext()==true){
while(folders.hasNext()){
var folder = folders.next();
folderlist.push(folder.getId());
}
}
//配列0番目を削除と詰める
folderlist.splice(0,1);
}
//folderlistが空ならsubfolderflagを0にする
if(folderlist.length == 0){
subfolderflag=0;
}
}
//filelist書き込み処理
var lastColumn = filelist[1].length; //カラムの数を取得する
var lastRow = filelist.length; //行の数を取得する
sheet.getRange(2,1,lastRow,lastColumn).setValues(filelist);
//終了処理
SpreadsheetApp.flush();
ui.alert("リストアップが終了しました。");
}
- 今回は条件を付けて、Google Spreadsheet形式のファイルだけを探索してピックアップしています。
- 指定フォルダ以下に所属しているスプレッドシートのIDと名前をリストアップしています。
- Google Driveの他のフォルダにも所属させるテクニックを併用すると、１箇所にバラバラのフォルダに属しているファイルを集めておくことができるので、コード実行が早く完了します。
- 特定フォルダではなく、ルートフォルダ（マイドライブ直下）から始める場合は、DriveApp.getRootFolder().getId();でIDを取得させると良い。
基準フォルダから下のフォルダ階層をすべてリストアップするコード
//基準フォルダから下のフォルダ階層をすべてリストアップするコード
function driveman3(){
//Drive APIで特定のファイルをリストとして取得
var key = folderid;
var nowdir = key;
var totalcount=0;
//folderlistシートに移動し内容をクリアする
var mvsheet = SpreadsheetApp.getActiveSpreadsheet();
mvsheet.getSheetByName("folderlist").activate();
var sheet = SpreadsheetApp.getActiveSheet();
sheet.getRange("A2:C").clearContent();
var Cell = SpreadsheetApp.getActiveSheet().getRange("A2");//offsetの参照点セルを設定
Cell.activate();
//フラグ類
var subfolderflag = 0; //1なら有り、0なら無し。
//次にフォルダがあるか検索し、あった場合にはフォルダリスト配列に格納する
var folderlist = new Array();
var folders = DriveApp.searchFolders("'"+key+"' in parents");
if(folders.length == 0){
//普通に指定フォルダ内のファイルのリストを書き出して終了
}else{
//サブフォルダフラグを立てる
subfolderflag=1;
//folderlistシートへ書き込み
while(folders.hasNext()){
var folder = folders.next();
Cell.offset(totalcount, 0).setValue(folder.getName());
Cell.offset(totalcount, 1).setValue(folder.getId());
Cell.offset(totalcount, 2).setValue(nowdir);
folderlist.push(folder.getId());
totalcount++;
}
}
//サブフォルダ以降のフォルダの探索ルーチン
var sub = 1;
while (sub == 1) {
var nowponyo = folderlist.length;
for(var i = 0;i<nowponyo;i++){
//0番目の配列のkeyを取得する
key = folderlist[0];
//そのkeyのフォルダにぶら下がるフォルダをリストアップ
folders = DriveApp.searchFolders("'"+key+"' in parents");
nowdir = key;
//folderlistシートへ書き込み
if(folders.hasNext()==true){
while(folders.hasNext()){
var folder = folders.next();
Cell.offset(totalcount, 0).setValue(folder.getName());
Cell.offset(totalcount, 1).setValue(folder.getId());
Cell.offset(totalcount, 2).setValue(nowdir);
folderlist.push(folder.getId());
totalcount++;
}
}
//配列0番目を削除と詰める
folderlist.splice(0,1);
}
//folderlistが空ならsubfolderflagを0にする
if(folderlist.length == 0){
sub=0;
}
}
//終了処理
SpreadsheetApp.flush();
SpreadsheetApp.getUi().alert("リストアップが終了しました。");
}
- folderlistシートに指定フォルダ以下のフォルダ構造をリストアップします。
- そのフォルダのIDと所属してる親フォルダのIDを記述します。
- 現在、Google Driveはフォルダ単位でのコピーができません。よって、Google Apps Scriptで作成し作りこんだファイルの複製は、サブフォルダまで含めて、すべて自分で手動で行う必要性があります。
- folderlistに出来上がるリストは、左から【フォルダ名】【そのフォルダのID】【所属する親フォルダのID】となっています。
ポイント
検索条件概要
- title ・・・要するにファイル名での検索をする
- fullText・・・要するに全文検索。そのワードが入っているファイルを検索する。
- mimeType・・・ファイルの形式。正直ちょっと指定には癖がある。今回のキモの一つ。
- modifiedDate・・・編集日で検索をする。
- lastViewedByMeDate・・・最後に自分が見たファイルの日付で検索するもの。
- trashed・・・削除したファイルを検索。ゴミ箱あさり。
- starrad・・・⭐をつけたファイルを検索。
- parents・・・親フォルダIDに所属しているファイルを検索
- owners・・・ファイルのオーナーで検索する
- writers・・・そのファイルの編集者で検索する
- readers・・・そのファイルの閲覧者で検索する
- sharedWithMe・・・自分と共有しているファイルについて検索する
- かならずダブルコーテーション（" "）でくくった中にオプションを書くこと。
- 条件の指定はシングルコーテーション（' '）でくくった中に書くこと。
- 変数を用いる場合にはちょっと特別な書き方をする。下の方にある検索条件の一部に変数を使用するを参考にしてください。
- 支店別に用意した特定のスプレッドシートという事をやりたい場合には、更にファイル名を決めて於いてそれを含むという条件を加え、サブフォルダ以下にその名称を含む他のファイルを設置しないなどの運用ルールが必要です。
mimetypeの指定
今回想定しているケースは特定のフォルダ内のファイルを検索することにあるのですが、スプレッドシートデータだけをヒットさせたい場合には、ファイルタイプが絶対不可欠です。下のEnum MimeTypeで紹介されているようなものでも動くのかもしれませんが、今回は普通通り、きちんとしたMimeTypeを指定することにしました。この辺りがしっかりリファレンスに記載されていなかったりします。Google Docs関係のMimeTypeはこちらにまとめられていますので参考にしましょう。
今回は、スプレッドシートのみをヒットさせたいので、以下のように記述します。
DriveApp.searchFiles("mimeType = 'application/vnd.google-apps.spreadsheet'");
検索条件の一部に変数を利用する
プログラミングじゃ当たり前のように変数を検索条件の一部に使用するわけなのですが、VBA上がりの人間などだと、ダブルコーテーションで閉じたあとに、アンパサンドや＋などで続ければ条件式に入ると思いがち。しかし、Google Apps Scriptでは、シングルコーテーションでくくり、なおかつダブルコーテーションでくくり、その中で＋変数＋と記述するのがルールになっています。これをやらないとエラーになります。気がつくのに自分は無駄な時間を大量に消費しました。ということで、以下のようになります。keyという変数の中の値を検索条件の一部として使用しています。
DriveApp.searchFiles("'"+key+"' in parents");
複数の条件式をつなげる場合には、andなどをいれる点は、他の言語と変わりありません。
サブフォルダ以下を探索させるために
今回のスクリプトでは、指定フォルダ内だけでなく、指定フォルダ内にあるサブフォルダ以下のフォルダ内全ての配下のスプレッドシートを列挙するという仕組みになっています。その為、探索段階では、どれだけのサブフォルダが隠れているのかはわかりません。そこで、配列としてfolderlistを用意し、新たにフォルダを発見したら配列に追加し、終了したものから配列から削除するというルーチンが入っています。配列の上から順番にフォルダを探索していくので0番目を削除しているのはそういうことです。（folderlist.splice(0,1)がそれをやってる。）
最終的にフォルダリストが空になったら、探索は終了し、flielistに格納されてる配列を一気にスプレッドシートに書き込みをします。
Drive APIを利用して更に情報を取得する
最終更新者情報を取得する
DriveAppでは、最終更新日は取得できても最終更新者の情報が取得できなかったりします。そこでこの部分を補完する為に、Drive APIを使って取得する事が可能です。これはFolderに対しても同様です。
var fileman = Drive.Files.get(fileid,{supportsAllDrives:true});
var lastman = fileman.lastModifyingUser.emailAddress;
この時、共有ドライブの場合はオプションとして、supportsAllDrivesをtrueとして付与しないとエラーとなってしまうので注意。ユーザの名前もこれで取得する事が可能です。
※fileman.fileSizeとすればファイルサイズなんかも取れたりする
版の情報を取得する
Google Apps ScriptのDriveAppによりFileを取得して、getId()でファイルのIDが取得可能ですが、Fileクラスで取得できる情報は限定されています。IDや権限、ファイルサイズ、URL、Mimetype、最終更新日などは取得できるのですが、例えばファイルに付けられている「説明欄」の情報や、ファイルのアイコン、リビジョン（版）の情報などはDrive APIを利用しなければ取得出来ません。
使い方は簡単で
- スクリプトエディタの左サイドバーのサービスの＋ボタンをクリック
- Drive APIを選択して、追加ボタンを押す
これで、スクリプトから操作可能になります。例として説明欄のコメントや版数は以下のコードで取得可能です。
//ファイルの説明と版数を取得して返す（Drive APIを利用）
function getrevisionlist(fileId){
//返却用変数
var array = [];
var rev = Drive.Revisions.list(fileId);
//最終版の値と説明文を取得する
array.push(rev.items.length);
array.push(Drive.Files.get(fileId).description)
//配列を返す
return array;
}
Drive.Files.getで様々な情報、Drive.Revisions.listでリビジョンファイルの詳細な情報を取得可能です。
図：ファイルの説明欄の情報まで取得可能
実行と結果
スプレッドシートのメニューより「ファイル探索」を開きます。3個のメニューがあり、リストは洗い替えでリストアップされる仕組みになっています。挙動は動画のような感じになります。フォルダ階層が複雑で深すぎると、タイムアウトする恐れがありますので、実用時には、特定のファイルはシンボリックリンク的に、１つの特定フォルダにファイルを集めておくと良いです。
- 単一フォルダ - 指定フォルダ直下のファイルをリストアップします。
- サブフォルダ含む - 指定フォルダ直下以外にもサブフォルダ以下もすべて探索しリストアップします。
- フォルダ階層列挙 - 指定フォルダ以下のフォルダ階層構造を列挙します。
関連リンク
- Drive SDK - Search for Files
- Enum MimeType
- Google Script to Import CSV file from file list
- Google Drive APIによるファイル管理 (1/5) - ファイル／フォルダの一覧を取得する
- Can the new DriveApp parameters be used to search a specific folder?
- What are the Google Apps MIME Types in Google Docs and Google Drive?
- MimeType一覧
- How to create a GUID / UUID in Javascript?
- Advanced Drive Service
