【Google Apps Script(gas)】Google Driveを使ったファイルの操作について – 後編

2019年9月16日2020年4月5日Google Apps

Google DriveにあるフォルダをGoogle Apps Scriptでファイルを操作する方法について、まとめてみようと思います。
後編ということで、コピーを作成する、ファイル名を変更する、ファイルサイズを取得する、権限を持っているユーザの一覧を取得する方法について書いてみようと思います。

1. ファイルをコピーする
2. ファイル名を変更する
- 2.1. setName(name)のサンプル
3. ファイルサイズを取得する
4. 権限を持っているユーザの一覧を取得する
- 4.1. 編集者(Editor)の一覧を取得するサンプル
- 4.2. 閲覧者(Viewer)の一覧を取得するサンプル
5. まとめ

ファイルをコピーする

ファイルをコピーするにはmakeCopy()を使用します。makeCopy()には引数が設定でき、下記のように使い分けができます。

makeCopy()：スクリプトが実行されたフォルダにファイルのコピーを作成する。
makeCopy(destination)：任意のフォルダにファイルのコピーを作成する。
makeCopy(name)：スクリプトが実行されたフォルダに任意のファイル名でファイルのコピーを作成する。
makeCopy(name, destination)：任意のフォルダに任意のファイル名でファイルのコピーを作成する。

makeCopy()を使ったサンプル

function myFunction() {
  /** コピー元ファイル */
  var file = DriveApp.getFileById(__FILE_ID__);
  /** コピー実行 */
  var newFile = file.makeCopy();
}

makeCopy(destination)を使ったサンプル

function myFunction() {
  /** コピー元ファイル */
  var file = DriveApp.getFileById(__FILE_ID__);
  /** コピーしたファイルを置くディレクトリ */
  var folder = DriveApp.getFolderById(__FILDER_ID__);
  
  var newFile = file.makeCopy(folder);
}

makeCopy(name)を使ったサンプル

function myFunction() {
  /** コピー元ファイル */
  var file = DriveApp.getFileById(__FILE_ID__);
  
  var newFile = file.makeCopy('任意のファイル名');
}

makeCopy(name, destination)を使ったサンプル

function myFunction() {
  /** コピー元ファイル */
  var file = DriveApp.getFileById(__FILE_ID__);
  /** コピーしたファイルを置くディレクトリ */
  var folder = DriveApp.getFolderById(__FILDER_ID__);
  
  var newFile = file.makeCopy('任意のファイル名', folder);
}

ファイル名を変更する

ファイル名を変更するにはsetName()のメソッドを使用します。

setName(name)のサンプル

function myFunction() {
  /** コピー元ファイル */
  var file = DriveApp.getFileById(__FILE_ID__);
  /** ファイル名を変更 */
  file.setName('変更したファイル名');
}

ファイルサイズを取得する

ファイルサイズを取得するケースとしては、ログファイルのローテート処理をバッチ化している際に判定材料として使えるのではないかと思います。

ファイルサイズを取得するには、getSize()を使用します。

function myFunction() {
  /** 元ファイル */
  var file = DriveApp.getFileById(__FILE_ID__);
  /** ファイルサイズを取得する */
  var fileSize = file.getSize();
  Logger.log(fileSize);
}

権限を持っているユーザの一覧を取得する

GoogleDriveで管理しているファイルには権限が付与されていて、他のユーザをファイル(フォルダも含む)を共有した時に効力を発揮します。

権限には「オーナー(Owner)」・「編集者(Editor)」・「コメント可(Commenter)」・「閲覧者(Viewer)」があり、特定のファイルについて、権限が付与されているユーザの一覧を取得することができます。

オーナー(Owner)：getOwner()
編集者(Editor)の一覧：getEditors()
コメント可(Commenter)の一覧：取得する方法なし
閲覧者(Viewer)の一覧：getViewers()

編集者(Editor)の一覧を取得するサンプル

function myFunction() {
  /** 元ファイル */
  var file = DriveApp.getFileById(__FILE_ID__);
  /** 編集者(Editor)の一覧を取得する */
  var editors = file.getEditors();
  editors.forEach(function (editor) {
        Logger.log(editor);
  });
}

閲覧者(Viewer)の一覧を取得するサンプル

function myFunction() {
  /** 元ファイル */
  var file = DriveApp.getFileById(__FILE_ID__);
  /** 閲覧者(Viewer)の一覧を取得する */
  var editors = file.getViewers();
  editors.forEach(function (editor) {
        Logger.log(editor);
  });
}