【GAS】でGoogleドライブのフォルダを使いこなす！　パラメータをいじろうの巻

GoogleAppsScirpt で、Google ドライブのフォルダのパラメータ（フォルダ名、ID、作成日など）を取得したり、編集ができます。
そのために、「Drive」サービスの中の「Folder」クラスのメソッドを使いますので、主にそれらの説明をします。

ここで、説明をしやすくするため、予め以下の構成であるフォルダ（名前：folder_A）のオブジェクト（folder という変数名）があるとさせてもらいます。

フォルダ名

• フォルダ名を取得

getName()
引数：無し
戻り値：フォルダ名（文字列）

let folderName = folder.getName();
console.log(folderName); // → 'folder_A'

• フォルダ名を設定

setName(フォルダ名)
引数：フォルダ名（文字列）
戻り値：フォルダ名が変更された Folder クラスのオブジェクト

let renamedFolder = folder.setName('new_folder');
console.log(renameFolder.getName()) // → 'new_folder'

フォルダ ID

フォルダにはそれぞれ固有の ID が振られています。
GoogleAppsScript でそのフォルダにアクセスする際などでフォルダの ID を使います。
なお、フォルダ ID は変更ができません。

• フォルダ ID の取得

getId()
引数：無し
戻り値：フォルダの ID（文字列）

let folderId = folder.getId();
console.log(folderId) // → "abcdefg1234"

フォルダ URL

フォルダをブラウザ上の Google ドライブで、閲覧などする場合にアクセスするための URL になります。

フォルダ URL は

「https://drive.google.com/drive/folders/フォルダID」

となっております。

• フォルダの URL の取得

getUrl()
引数：無し
戻り値：フォルダの URL（文字列）

let folderURL = folder.getUrl();
console.log(folderURL) // → 'https://drive.google.com/drive/folders/abcdefg1234'

説明

Google ドライブではフォルダに、それがどの様なものなのか、説明を設定できます。
例えば、「note の記事の資料のフォルダ」などフォルダ名では表しきれないことを詳しく書けます。

• フォルダの説明を取得

getDescription()
引数：無し
戻り値：フォルダの説明（文字列）

let folderDescription = folder.getDescription();
console.log(folderDescription); // → '説明: これはサンプルフォルダです。'

• フォルダの説明を変更

setDescription(説明文)
引数：説明文（文字列）
戻り値：説明文が変更された Folder クラスのオブジェクト

let newDescriptionFolder = folder.setDescription('新しい説明文を設定してみました！');
console.log(newDescriptionFolder.getDescription()); // → '新しい説明文を設定してみました！'

作成日

フォルダを作成した日時を取得のみできます。

なお、日時は Date クラスのオブジェクトとして得ることができます。
この Date クラスは、javascript などにあるそれと同じため、使い方などの説明は割愛します。

getDateCreated()
引数：無し
戻り値：作成した日時の Date クラスのオブジェクト

let dateCreated = folder.getDateCreated();
console.log(dateCreated.toString()); // → ”Fri Feb 24 2024 11:17:07 GMT+0900 (Japan Standard Time)”

最終更新日

フォルダを一番最後に更新した日時を取得のみできます。
フォルダの更新とは、フォルダの名前や説明を変更した時を指し、フォルダにファイルを追加したなど、間接的な変更などは該当しません。

なお、作成日を取得した場合と同じく、日時は Date クラスのオブジェクトとして得ることができます。
この Date クラスは、javascript などにあるそれと同じため、使い方などの説明は割愛します。

getLastUpdated()
引数：無し
戻り値：作成した日時の Date クラスのオブジェクト

let lastUpdated = folder.getLastUpdated();
console.log(lastUpdated.toString()); // → ”Fri Mar 15 2024 01:11:10 GMT+0900 (Japan Standard Time)”

フォルダの容量

そのフォルダが保持しているフォルダやファイルの容量（バイト数）の総量ではなく、だいたい０となる様です。

getSize()
引数：無し
戻り値：だいたいゼロ（数値）

console.log(folder.getSize); //　→ 0

フォルダがゴミ箱にあるかどうか

そのフォルダがゴミ箱にあるのかどうかを確認します。

isTrashed()
引数：無し
戻り値：ゴミ箱にある →true 　か　ゴミ箱にない →false 　かの bool 値

console.log(folder.isTrashed()); // → 'false'

フォルダがお気に入りになっているかどうか

そのフォルダがお気に入り（スターがついている）かどうかを確認します。

isStarred()
引数：無し
戻り値：スターが付いている →true 　か　スターが付いていない →false 　かの bool 値

console.log(folder.isStarred()); // → 'true'