Class Folder

Google ドライブ内のフォルダ。フォルダには DriveApp からアクセスまたは作成できます。

// Log the name of every folder in the user's Drive.
const folders = DriveApp.getFolders();
while (folders.hasNext()) {
  const folder = folders.next();
  Logger.log(folder.getName());
}

メソッド

メソッド	戻り値の型	概要
`addEditor(emailAddress)`	`Folder`	指定されたユーザーを `Folder` の編集者のリストに追加します。
`addEditor(user)`	`Folder`	指定されたユーザーを `Folder` の編集者のリストに追加します。
`addEditors(emailAddresses)`	`Folder`	指定されたユーザーの配列を `Folder` の編集者のリストに追加します。
`addViewer(emailAddress)`	`Folder`	指定されたユーザーを `Folder` の閲覧者リストに追加します。
`addViewer(user)`	`Folder`	指定されたユーザーを `Folder` の閲覧者リストに追加します。
`addViewers(emailAddresses)`	`Folder`	指定されたユーザーの配列を `Folder` の視聴者リストに追加します。
`createFile(blob)`	`File`	任意のデータの指定された `Blob` から現在のフォルダにファイルを作成します。
`createFile(name, content)`	`File`	現在のフォルダに、指定された名前と内容のテキストファイルを作成します。
`createFile(name, content, mimeType)`	`File`	指定された名前、内容、MIME タイプで現在のフォルダにファイルを作成します。
`createFolder(name)`	`Folder`	現在のフォルダに、指定された名前のフォルダを作成します。
`createShortcut(targetId)`	`File`	指定されたドライブアイテム ID へのショートカットを作成して返します。
`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`	`File`	指定された Google ドライブアイテム ID とリソースキーへのショートカットを作成して返します。
`getAccess(email)`	`Permission`	特定のユーザーに付与された権限を取得します。
`getAccess(user)`	`Permission`	特定のユーザーに付与された権限を取得します。
`getDateCreated()`	`Date`	`Folder` が作成された日付を取得します。
`getDescription()`	`String`	`Folder` の説明を取得します。
`getEditors()`	`User[]`	この `Folder` の編集者のリストを取得します。
`getFiles()`	`FileIterator`	現在のフォルダの子であるすべてのファイルのコレクションを取得します。
`getFilesByName(name)`	`FileIterator`	現在のフォルダの子で、指定された名前を持つすべてのファイルのコレクションを取得します。
`getFilesByType(mimeType)`	`FileIterator`	現在のフォルダの子で、指定された MIME タイプのすべてのファイルのコレクションを取得します。
`getFolders()`	`FolderIterator`	現在のフォルダの子であるすべてのフォルダのコレクションを取得します。
`getFoldersByName(name)`	`FolderIterator`	現在のフォルダの子で、指定された名前を持つすべてのフォルダのコレクションを取得します。
`getId()`	`String`	`Folder` の ID を取得します。
`getLastUpdated()`	`Date`	`Folder` が最後に更新された日付を取得します。
`getName()`	`String`	`Folder` の名前を取得します。
`getOwner()`	`User`	この `Folder` のオーナーを取得します。
`getParents()`	`FolderIterator`	`Folder` の直近の親フォルダのコレクションを取得します。
`getResourceKey()`	`String`	リンクを使用して共有されたアイテムにアクセスするために必要な `Folder` のリソースキーを取得します。
`getSecurityUpdateEligible()`	`Boolean`	この `Folder` が、リンクを使用して共有されたときにアクセスにリソースキーを必要とするセキュリティアップデートを適用できるかどうかを取得します。
`getSecurityUpdateEnabled()`	`Boolean`	この `Folder` がリンクを使用して共有されるときに、アクセスにリソースキーが必要かどうかを取得します。
`getSharingAccess()`	`Access`	明示的にアクセス権が付与された個々のユーザーを除き、どのクラスのユーザーが `Folder` にアクセスできるかを取得します。
`getSharingPermission()`	`Permission`	`Folder` にアクセスできるユーザーに付与された権限を取得します。明示的にアクセス権が付与された個々のユーザーは除きます。
`getSize()`	`Integer`	ドライブに `Folder` を保存するために使用されるバイト数を取得します。
`getUrl()`	`String`	ドライブやドキュメントなどの Google アプリで `Folder` を開くために使用できる URL を取得します。
`getViewers()`	`User[]`	この `Folder` の閲覧者とコメント投稿者のリストを取得します。
`isShareableByEditors()`	`Boolean`	`Folder` の編集権限を持つユーザーが、他のユーザーと共有したり、権限を変更したりできるかどうかを指定します。
`isStarred()`	`Boolean`	`Folder` がユーザーのドライブでスター付きになっているかどうかを判断します。
`isTrashed()`	`Boolean`	`Folder` がユーザーのドライブのゴミ箱にあるかどうかを判断します。
`moveTo(destination)`	`Folder`	このアイテムを指定された移動先フォルダに移動します。
`removeEditor(emailAddress)`	`Folder`	指定されたユーザーを `Folder` の編集者リストから削除します。
`removeEditor(user)`	`Folder`	指定されたユーザーを `Folder` の編集者リストから削除します。
`removeViewer(emailAddress)`	`Folder`	指定されたユーザーを `Folder` の閲覧者とコメント投稿者のリストから削除します。
`removeViewer(user)`	`Folder`	指定されたユーザーを `Folder` の閲覧者とコメント投稿者のリストから削除します。
`revokePermissions(emailAddress)`	`Folder`	指定されたユーザーに付与された `Folder` へのアクセス権を取り消します。
`revokePermissions(user)`	`Folder`	指定されたユーザーに付与された `Folder` へのアクセス権を取り消します。
`searchFiles(params)`	`FileIterator`	現在のフォルダの子で、指定された検索条件に一致するすべてのファイルのコレクションを取得します。
`searchFolders(params)`	`FolderIterator`	現在のフォルダの子で、指定された検索条件に一致するすべてのフォルダのコレクションを取得します。
`setDescription(description)`	`Folder`	`Folder` の説明を設定します。
`setName(name)`	`Folder`	`Folder` の名前を設定します。
`setOwner(emailAddress)`	`Folder`	`Folder` のオーナーを変更します。
`setOwner(user)`	`Folder`	`Folder` のオーナーを変更します。
`setSecurityUpdateEnabled(enabled)`	`Folder`	リンクを使用して共有されたときに、`Folder` でアクセスにリソースキーが必要かどうかを設定します。
`setShareableByEditors(shareable)`	`Folder`	`Folder` の編集権限を持つユーザーが他のユーザーと共有したり、権限を変更したりすることを許可するかどうかを設定します。
`setSharing(accessType, permissionType)`	`Folder`	`Folder` にアクセスできるユーザーのクラスと、明示的にアクセス権が付与された個々のユーザーに加えて、それらのユーザーに付与される権限を設定します。
`setStarred(starred)`	`Folder`	ユーザーのドライブで `Folder` にスターを付けるかどうかを設定します。
`setTrashed(trashed)`	`Folder`	`Folder` がユーザーのドライブのゴミ箱にあるかどうかを設定します。

サポート終了のメソッド

メソッド	戻り値の型	概要
`addFile(child)`	`Folder`	指定されたファイルを現在のフォルダに追加します。
`addFolder(child)`	`Folder`	指定されたフォルダを現在のフォルダに追加します。
`removeFile(child)`	`Folder`	指定されたファイルを現在のフォルダから削除します。
`removeFolder(child)`	`Folder`	指定されたフォルダを現在のフォルダから削除します。

詳細なドキュメント

`addEditor(emailAddress)`

指定されたユーザーを Folder の編集者のリストに追加します。ユーザーがすでに視聴者リストに登録されている場合、このメソッドはユーザーを視聴者リストから昇格させます。

パラメータ

名前	型	説明
`emailAddress`	`String`	追加するユーザーのメールアドレス。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`addEditor(user)`

パラメータ

名前	型	説明
`user`	`User`	追加するユーザーの表現。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`addEditors(emailAddresses)`

指定されたユーザーの配列を Folder の編集者のリストに追加します。ユーザーが視聴者リストにすでに含まれている場合、このメソッドは視聴者リストからそのユーザーを昇格させます。

パラメータ

名前	型	説明
`emailAddresses`	`String[]`	追加するユーザーのメールアドレスの配列。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`addViewer(emailAddress)`

指定されたユーザーを Folder の閲覧者リストに追加します。ユーザーがすでに編集者のリストに登録されている場合、このメソッドは効力がありません。

パラメータ

名前	型	説明
`emailAddress`	`String`	追加するユーザーのメールアドレス。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`addViewer(user)`

パラメータ

名前	型	説明
`user`	`User`	追加するユーザーの表現。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`addViewers(emailAddresses)`

指定されたユーザーの配列を Folder の視聴者リストに追加します。ユーザーがすでに編集者のリストに含まれている場合、このメソッドは効果がありません。

パラメータ

名前	型	説明
`emailAddresses`	`String[]`	追加するユーザーのメールアドレスの配列。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`createFile(blob)`

任意のデータの指定された Blob から現在のフォルダにファイルを作成します。

パラメータ

名前	型	説明
`blob`	`BlobSource`	新しいファイルのデータ。

戻る

File - 新しいファイル。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`createFile(name, content)`

現在のフォルダに、指定された名前と内容のテキストファイルを作成します。content が 50 MB を超える場合は例外をスローします。

// Create a text file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New Text File', 'Hello, world!');

パラメータ

名前	型	説明
`name`	`String`	新しいファイルの名前。
`content`	`String`	新しいファイルの内容。

戻る

File - 新しいファイル。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`createFile(name, content, mimeType)`

指定された名前、内容、MIME タイプで、現在のフォルダにファイルを作成します。content が 10 MB を超える場合は例外をスローします。

// Create an HTML file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

パラメータ

名前	型	説明
`name`	`String`	新しいファイルの名前。
`content`	`String`	新しいファイルの内容。
`mimeType`	`String`	新しいファイルの MIME タイプ。

戻る

File - 新しいファイル。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`createFolder(name)`

現在のフォルダに、指定された名前のフォルダを作成します。

パラメータ

名前	型	説明
`name`	`String`	新しいフォルダの名前。

戻る

Folder - 新しいフォルダ。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`createShortcut(targetId)`

指定されたドライブアイテム ID へのショートカットを作成して返します。

パラメータ

名前	型	説明
`targetId`	`String`	ターゲットファイルまたはフォルダのファイル ID。

戻る

File - 新しいショートカット。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`

指定された Google ドライブアイテム ID とリソースキーへのショートカットを作成して返します。リソースキーは、リンクを使用して共有されたターゲットファイルまたはフォルダにアクセスするために渡す必要がある追加のパラメータです。

// Creates shortcuts for all folders in the user's drive that have a specific
// name.
// TODO(developer): Replace 'Test-Folder' with a valid folder name in your
// drive.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and
  // returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(
      folder.getId(),
      folder.getResourceKey(),
  );
}

パラメータ

名前	型	説明
`targetId`	`String`	ターゲットファイルまたはフォルダの ID。
`targetResourceKey`	`String`	対象のファイルまたはフォルダのリソースキー。

戻る

File - 新しいショートカット。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`getAccess(email)`

特定のユーザーに付与された権限を取得します。このメソッドは、Google グループの権限や、Google グループを通じて継承された権限を返すことをサポートしていません。

パラメータ

名前	型	説明
`email`	`String`	権限を確認するユーザーのメールアドレス。Google グループはサポートされていません。

戻る

Permission - ユーザーに付与された権限。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getAccess(user)`

パラメータ

名前	型	説明
`user`	`User`	権限を確認するユーザーの表現。

戻る

Permission - ユーザーに付与された権限。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getDateCreated()`

Folder が作成された日付を取得します。

戻る

Date - Folder が作成された日付

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getDescription()`

Folder の説明を取得します。

戻る

String - Folder の説明

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getEditors()`

この Folder の編集者のリストを取得します。スクリプトを実行するユーザーに Folder の編集権限がない場合、このメソッドは空の配列を返します。

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of editors and logs their names to the console.
const editors = folder.getEditors();
for (const editor of editors) {
  console.log(editor.getName());
}

戻る

User[] - ユーザーに編集権限がある場合は、この Folder の編集者のリスト。それ以外の場合は空の配列。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getFiles()`

現在のフォルダの子であるすべてのファイルのコレクションを取得します。

戻る

FileIterator - 現在のフォルダの子であるすべてのファイルのコレクション。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getFilesByName(name)`

現在のフォルダの子で、指定された名前を持つすべてのファイルのコレクションを取得します。

パラメータ

名前	型	説明
`name`	`String`	検索するファイルの名前。

戻る

FileIterator - 現在のフォルダの子で、指定された名前を持つすべてのファイルのコレクション。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getFilesByType(mimeType)`

現在のフォルダの子で、指定された MIME タイプのすべてのファイルのコレクションを取得します。

パラメータ

名前	型	説明
`mimeType`	`String`	検索するファイルの MIME タイプ。

戻る

FileIterator - 現在のフォルダの子で、指定された MIME タイプを持つすべてのファイルのコレクション。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getFolders()`

現在のフォルダの子であるすべてのフォルダのコレクションを取得します。

戻る

FolderIterator - 現在のフォルダの子であるすべてのフォルダのコレクション。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getFoldersByName(name)`

現在のフォルダの子で、指定された名前を持つすべてのフォルダのコレクションを取得します。

パラメータ

名前	型	説明
`name`	`String`	検索するフォルダの名前。

戻る

FolderIterator - 現在のフォルダの子で、指定された名前を持つすべてのフォルダのコレクション。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getId()`

Folder の ID を取得します。

戻る

String - Folder の ID

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getLastUpdated()`

Folder が最後に更新された日付を取得します。

戻る

Date - Folder が最後に更新された日付

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getName()`

Folder の名前を取得します。

戻る

String - Folder の名前

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getOwner()`

この Folder のオーナーを取得します。

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the owner of the folder and logs the name to the console.
const folderOwner = folder.getOwner();
console.log(folderOwner.getName());

戻る

User - この Folder のオーナー。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getParents()`

Folder の直近の親フォルダのコレクションを取得します。

戻る

FolderIterator - Folder の直近の親であるフォルダのコレクション

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getResourceKey()`

リンクを使用して共有されたアイテムにアクセスするために必要な Folder のリソースキーを取得します。

戻る

String - Folder のリソースキー。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSecurityUpdateEligible()`

この Folder が、リンクを使用して共有されたときにアクセスにリソースキーを必要とするセキュリティアップデートを適用できるかどうかを取得します。

リンクを使用して共有された一部のファイルやフォルダにアクセスするには、ドライブでリソースキーが必要です。この変更は、セキュリティアップデートの一部です。この更新は、対象となるファイルとフォルダに対してデフォルトで有効になっています。対象となるファイルのリソースキー要件をオンまたはオフにするには、setSecurityUpdateEnabled を使用します。

詳しくは、Google ドライブのセキュリティアップデートをご覧ください。

戻る

Boolean - リソースキーの要件を Folder に適用できるかどうか。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSecurityUpdateEnabled()`

この Folder がリンクを使用して共有されるときに、アクセスにリソースキーが必要かどうかを取得します。この要件は、対象となるファイルとフォルダに対してデフォルトで有効になっています。対象となるファイルのリソースキー要件をオンまたはオフにするには、setSecurityUpdateEnabled を使用します。

詳しくは、Google ドライブのセキュリティアップデートをご覧ください。

戻る

Boolean - この Folder でリソースキーの要件が有効かどうか。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSharingAccess()`

明示的にアクセス権が付与された個々のユーザーを除き、どのクラスのユーザーが Folder にアクセスできるかを取得します。

戻る

Access - どのクラスのユーザーが Folder にアクセスできるか

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSharingPermission()`

Folder にアクセスできるユーザーに付与された権限を取得します。明示的にアクセス権が付与された個々のユーザーは除きます。

戻る

Permission - Folder にアクセスできるユーザーに付与される権限

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getSize()`

ドライブに Folder を保存するために使用されるバイト数を取得します。Google Workspace アプリケーションファイルはドライブの保存容量の上限にカウントされないため、0 バイトが返されます。

戻る

Integer - ドライブに Folder を保存するために使用されるバイト数

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getUrl()`

ドライブやドキュメントなどの Google アプリで Folder を開くために使用できる URL を取得します。

戻る

String - ドライブやドキュメントなどの Google アプリでこの Folder を表示するために使用できる URL

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`getViewers()`

この Folder の閲覧者とコメント投稿者のリストを取得します。スクリプトを実行するユーザーに Folder の編集権限がない場合、このメソッドは空の配列を返します。

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of viewers and logs their names to the console.
const viewers = folder.getViewers();
for (const viewer of viewers) {
  console.log(viewer.getName());
}

戻る

User[] - ユーザーが編集権限を持っている場合は、この Folder の閲覧者とコメント投稿者のリスト。それ以外の場合は空の配列。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`isShareableByEditors()`

Folder の編集権限を持つユーザーが、他のユーザーと共有したり、権限を変更したりできるかどうかを指定します。

戻る

Boolean - 編集権限を持つユーザーが他のユーザーと共有したり、権限を変更したりできる場合は true、できない場合は false

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`isStarred()`

Folder がユーザーのドライブでスター付きになっているかどうかを判断します。

戻る

Boolean - Folder がユーザーのドライブでスター付きの場合は true、そうでない場合は false

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`isTrashed()`

Folder がユーザーのドライブのゴミ箱にあるかどうかを判断します。

戻る

Boolean - Folder がユーザーのドライブのゴミ箱にある場合は true、そうでない場合は false

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`moveTo(destination)`

このアイテムを指定された移動先フォルダに移動します。

アイテムを移動先のフォルダに移動するには、現在のユーザーがファイルの所有者であるか、アイテムの現在の親フォルダに対する編集権限を持っている必要があります。

パラメータ

名前	型	説明
`destination`	`Folder`	新しい親になるフォルダ。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`removeEditor(emailAddress)`

指定されたユーザーを Folder の編集者リストから削除します。この方法では、ユーザーが一般的なアクセス権を持つユーザーのクラスに属している場合（たとえば、Folder がユーザーのドメイン全体と共有されている場合や、Folder がユーザーがアクセスできる共有ドライブにある場合など）、ユーザーが Folder にアクセスすることをブロックしません。

ドライブファイルの場合、この操作を行うと、閲覧者リストからもユーザーが削除されます。

パラメータ

名前	型	説明
`emailAddress`	`String`	削除するユーザーのメールアドレス。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`removeEditor(user)`

ドライブファイルの場合、この操作を行うと、閲覧者リストからもユーザーが削除されます。

パラメータ

名前	型	説明
`user`	`User`	削除するユーザーの表現。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`removeViewer(emailAddress)`

指定されたユーザーを Folder の閲覧者とコメント投稿者のリストから削除します。ユーザーが閲覧者やコメント投稿者ではなく編集者の場合、このメソッドは無効です。また、この方法では、ユーザーが一般アクセス権を持つユーザーのクラスに属している場合（たとえば、Folder がユーザーのドメイン全体と共有されている場合や、Folder がユーザーがアクセスできる共有ドライブにある場合など）、ユーザーが Folder にアクセスすることをブロックしません。

ドライブファイルの場合、この操作を行うと、ユーザーは編集者のリストからも削除されます。

パラメータ

名前	型	説明
`emailAddress`	`String`	削除するユーザーのメールアドレス。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`removeViewer(user)`

指定されたユーザーを Folder の閲覧者とコメント投稿者のリストから削除します。ユーザーが閲覧者ではなく編集者の場合、このメソッドは効果がありません。また、この方法では、一般アクセス権を持つユーザーのクラスに属しているユーザーが Folder にアクセスすることをブロックできません。たとえば、Folder がユーザーのドメイン全体と共有されている場合や、Folder がユーザーがアクセスできる共有ドライブにある場合などです。

ドライブファイルの場合、この操作を行うと、ユーザーは編集者のリストからも削除されます。

パラメータ

名前	型	説明
`user`	`User`	削除するユーザーの表現。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`revokePermissions(emailAddress)`

指定されたユーザーに付与された Folder へのアクセス権を取り消します。このメソッドは、ユーザーが一般アクセス権を持つユーザーのクラスに属している場合（たとえば、Folder がユーザーのドメイン全体と共有されている場合など）、ユーザーが Folder にアクセスすることをブロックしません。

パラメータ

名前	型	説明
`emailAddress`	`String`	アクセス権を取り消すユーザーのメールアドレス。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`revokePermissions(user)`

パラメータ

名前	型	説明
`user`	`User`	アクセス権を取り消すユーザーの表現。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`searchFiles(params)`

現在のフォルダの子で、指定された検索条件に一致するすべてのファイルのコレクションを取得します。検索条件の詳細については、Google ドライブ SDK のドキュメントをご覧ください。Drive サービスは Drive API の v2 を使用しており、一部のクエリフィールドは v3 と異なります。v2 と v3 のフィールドの違いを確認します。

params 引数は文字列値を含むことができるクエリ文字列であるため、引用符を正しくエスケープしてください（例: "title contains 'Gulliver\\'s Travels'" または 'title contains "Gulliver\'s Travels"'）。

// Logs the name of every file that are children of the current folder and modified after February 28,
// 2022 whose name contains "untitled.""
const files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

パラメータ

名前	型	説明
`params`	`String`	Google Drive SDK のドキュメントで説明されている検索条件。

戻る

FileIterator - 現在のフォルダの子で、検索条件に一致するすべてのファイルのコレクション。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`searchFolders(params)`

現在のフォルダの子フォルダで、指定された検索条件に一致するすべてのフォルダのコレクションを取得します。検索条件の詳細については、Google ドライブ SDK のドキュメントをご覧ください。Drive サービスは Drive API の v2 を使用しており、一部のクエリフィールドは v3 と異なります。v2 と v3 のフィールドの違いを確認します。

// Logs the name of every folder that are children of the current folder and you own and is starred.
const folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

パラメータ

名前	型	説明
`params`	`String`	Google Drive SDK のドキュメントで説明されている検索条件。

戻る

FolderIterator - 現在のフォルダの子で、検索条件に一致するすべてのフォルダのコレクション。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive.readonly
https://www.googleapis.com/auth/drive

`setDescription(description)`

Folder の説明を設定します。

パラメータ

名前	型	説明
`description`	`String`	`Folder` の新しい説明

戻る

Folder - チェーン用の Folder

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`setName(name)`

Folder の名前を設定します。

パラメータ

名前	型	説明
`name`	`String`	`Folder` の新しい名前

戻る

Folder - チェーン用の Folder

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`setOwner(emailAddress)`

Folder のオーナーを変更します。このメソッドは、以前のオーナーに Folder への明示的な編集アクセス権も付与します。

ドライブでは、gmail.com アカウントが所有するアイテムの所有権の変更はサポートされていません。Workspace アカウントではサポートされています。

パラメータ

名前	型	説明
`emailAddress`	`String`	新しいオーナーになるユーザーのメールアドレス。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`setOwner(user)`

Folder のオーナーを変更します。このメソッドは、以前のオーナーに Folder への明示的な編集アクセス権も付与します。

ドライブでは、gmail.com アカウントが所有するアイテムの所有権の変更はサポートされていません。Workspace アカウントではサポートされています。

パラメータ

名前	型	説明
`user`	`User`	新しいオーナーになるユーザーの表現。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`setSecurityUpdateEnabled(enabled)`

リンクを使用して共有されたときに、Folder がアクセスにリソースキーを必要とするかどうかを設定します。対象となるファイルとフォルダは、デフォルトで有効になっています。

詳しくは、Google ドライブのセキュリティアップデートをご覧ください。

パラメータ

名前	型	説明
`enabled`	`Boolean`	`Folder` のリソースキー要件を有効にするかどうか。

戻る

Folder - チェーン用の Folder。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`setShareableByEditors(shareable)`

Folder の編集権限を持つユーザーが他のユーザーと共有したり、権限を変更したりすることを許可するかどうかを設定します。新しい Folder のデフォルトは true です。

パラメータ

名前	型	説明
`shareable`	`Boolean`	編集権限を持つユーザーが他のユーザーと共有したり、権限を変更したりできるようにする場合は `true`、そうでない場合は `false`

戻る

Folder - チェーン用の Folder

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`setSharing(accessType, permissionType)`

Folder にアクセスできるユーザーのクラスと、明示的にアクセス権が付与された個々のユーザーに加えて、それらのユーザーに付与される権限を設定します。

// Creates a folder that anyone on the Internet can read from and write to.
// (Domain administrators can prohibit this setting for users of a Google
// Workspace domain.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

パラメータ

名前	型	説明
`accessType`	`Access`	どのクラスのユーザーが `Folder` にアクセスできるようにするか
`permissionType`	`Permission`	`Folder` にアクセスできるユーザーに付与する必要がある権限

戻る

Folder - チェーン用の Folder

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`setStarred(starred)`

ユーザーのドライブで Folder にスターを付けるかどうかを設定します。新しい Folder のデフォルトは false です。

パラメータ

名前	型	説明
`starred`	`Boolean`	`Folder` をユーザーのドライブでスター付きにする場合は `true`、そうでない場合は `false`

戻る

Folder - チェーン用の Folder

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`setTrashed(trashed)`

Folder がユーザーのドライブのゴミ箱にあるかどうかを設定します。Folder をゴミ箱に移動できるのはオーナーのみです。新しい Folder のデフォルトは false です。

パラメータ

名前	型	説明
`trashed`	`Boolean`	`Folder` をユーザーのドライブのゴミ箱に移動する場合は `true`、移動しない場合は `false`

戻る

Folder - チェーン用の Folder

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

サポート終了のメソッド

`addFile(child)`

非推奨。代わりに、File.moveTo(destination) または createShortcut(targetId) を使用します。

指定されたファイルを現在のフォルダに追加します。このメソッドでは、ファイルは既存の親フォルダから移動されません。ファイルには複数の親を同時に設定できます。

パラメータ

名前	型	説明
`child`	`File`	追加する子ファイル。

戻る

Folder - 子として追加されたファイルの新しい親。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`addFolder(child)`

非推奨。代わりに、moveTo(destination) または createShortcut(targetId) を使用します。

指定されたフォルダを現在のフォルダに追加します。このメソッドでは、フォルダは既存の親フォルダから移動されません。フォルダには複数の親を同時に設定できます。

パラメータ

名前	型	説明
`child`	`Folder`	追加する子フォルダ。

戻る

Folder - 子として追加されたフォルダの新しい親。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`removeFile(child)`

非推奨。代わりに File.moveTo(destination) を使用します。

指定されたファイルを現在のフォルダから削除します。このメソッドではファイルは削除されませんが、ファイルがすべての親から削除された場合、検索するか [すべてのアイテム] ビューを使用しない限り、ドライブで表示できません。

パラメータ

名前	型	説明
`child`	`File`	削除する子ファイル。

戻る

Folder - 子の以前の親。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

`removeFolder(child)`

非推奨。代わりに moveTo(destination) を使用します。

指定されたフォルダを現在のフォルダから削除します。この方法では、フォルダとそのコンテンツは削除されませんが、フォルダがすべての親フォルダから削除されると、検索するか [すべてのアイテム] ビューを使用しない限り、ドライブに表示されなくなります。

パラメータ

名前	型	説明
`child`	`Folder`	削除する子フォルダ。

戻る

Folder - 子の以前の親。

承認

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/drive

Class Folder コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

メソッド

サポート終了のメソッド

詳細なドキュメント

addEditor(emailAddress)

パラメータ

戻る

承認

addEditor(user)

パラメータ

戻る

承認

addEditors(emailAddresses)

パラメータ

戻る

承認

addViewer(emailAddress)

パラメータ

戻る

承認

addViewer(user)

パラメータ

戻る

承認

addViewers(emailAddresses)

パラメータ

戻る

承認

createFile(blob)

パラメータ

戻る

承認

createFile(name, content)

パラメータ

戻る

承認

createFile(name, content, mimeType)

パラメータ

戻る

承認

createFolder(name)

パラメータ

戻る

承認

createShortcut(targetId)

パラメータ

戻る

承認

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

パラメータ

戻る

承認

getAccess(email)

パラメータ

戻る

承認

getAccess(user)

パラメータ

戻る

承認

getDateCreated()

戻る

承認

getDescription()

戻る

承認

getEditors()

戻る

承認

getFiles()

戻る

承認

getFilesByName(name)

パラメータ

戻る

承認

getFilesByType(mimeType)

パラメータ

戻る

承認

Class Folder

`addEditor(emailAddress)`

`addEditor(user)`

`addEditors(emailAddresses)`

`addViewer(emailAddress)`

`addViewer(user)`

`addViewers(emailAddresses)`

`createFile(blob)`

`createFile(name, content)`

`createFile(name, content, mimeType)`

`createFolder(name)`

`createShortcut(targetId)`

`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`

`getAccess(email)`

`getAccess(user)`

`getDateCreated()`

`getDescription()`

`getEditors()`

`getFiles()`

`getFilesByName(name)`

`getFilesByType(mimeType)`

`getFolders()`

`getFoldersByName(name)`

`getId()`

`getLastUpdated()`

`getName()`

`getOwner()`

`getParents()`

`getResourceKey()`

`getSecurityUpdateEligible()`

`getSecurityUpdateEnabled()`

`getSharingAccess()`

`getSharingPermission()`

`getSize()`

`getUrl()`

`getViewers()`

`isShareableByEditors()`

`isStarred()`

`isTrashed()`

`moveTo(destination)`

`removeEditor(emailAddress)`

`removeEditor(user)`

`removeViewer(emailAddress)`