【GAS】Googleドライブの指定フォルダのファイルを削除する（setTrashed/removeFile）

この記事では、Googleドライブ上にあるファイルを削除するスクリプトを紹介します。

ファイルの削除だから「delete~~」のようなメソッドがあるかと思いきや・・・ないんですね。

そこで、「削除」に関する2つのメソッドを紹介します。

①ファイルを削除する
→Fileオブジェクト.setTrashedメソッド

②指定フォルダへのファイル追加を外す
→Folderオブジェクト.removeFileメソッド

Contents

ファイルを削除する
指定フォルダへのファイル追加を外す
【まとめ】setTrashedメソッドとremoveFileメソッドの違い
- setTrashedメソッド（ファイルをゴミ箱へ）
- removeFileメソッド（フォルダ追加を外す）

ファイルを削除する

こちらが一般的な「削除」で、ファイルをゴミ箱に入れる処理です。setTrashedメソッドを使用します。

Fileオブジェクト.setTrashed(trashed)

パラメータ：Boolean（trueを指定するとユーザーのドライブのゴミ箱に移動する）
戻り値：File
説明：ファイルがユーザーのドライブのゴミ箱にあるかどうかを設定します。ファイルを破棄できるのは所有者のみです。
公式リファレンスはこちら

サンプルスクリプトです。実行すると、指定のファイルがゴミ箱に移動します。

function setTrashedSample() {
  
  //削除したいファイルの「ファイルID」
  const fileId = '********************';
  const file = DriveApp.getFileById(fileId);
  
  file.setTrashed(true);
  
}

function setTrashedSample() {

//削除したいファイルの「ファイルID」

const fileId = '********************';

const file = DriveApp.getFileById(fileId);

file.setTrashed(true);

}

指定フォルダへのファイル追加を外す

フォルダとファイルの紐付けを外す（解除する）方法です。removeFileメソッドを使用します。

※Googleドライブでは、1つのファイルを複数フォルダに追加することができます（参考：【GAS】Googleドライブでファイルが追加されている全てのフォルダを取得する）

Folderオブジェクト.removeFile(child)

パラメータ：File（removeするファイルを指定）
戻り値：Folder
説明：指定ファイルを指定フォルダから外します。この方法ではファイルは削除されませんが、ファイルがそのすべての親から削除されると、ファイルを検索するか「すべてのアイテム」ビューを使用しない限り、ドライブに表示できません。
公式リファレンスはこちら

サンプルスクリプトです。実行すると、「指定ファイルの指定フォルダへの追加」が外されます。※ファイルはゴミ箱に移動しません。

function removeFileSample() {
  
  //フォルダ追加を外したいファイルの「ファイルID」
  const fileId = '********************';
  const file = DriveApp.getFileById(fileId);
  
  //上のfileが追加されているフォルダを指定
  const folderId = '********************';
  const folder = DriveApp.getFolderById(folderId);
  
  folder.removeFile(file);
  
}