このページは Cloud Translation API によって翻訳されました。

Class Folder

Google ドライブ内のフォルダ。フォルダへのアクセスと作成は DriveApp から行えます。

// Log the name of every folder in the user's Drive.
var folders = DriveApp.getFolders();
while (folders.hasNext()) {
  var 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`	指定されたドライブのアイテム 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)`

指定したユーザーを Folder の閲覧者のリストに追加します。ユーザーがすでにエディタのリストに含まれていると、このメソッドは機能しません。

パラメータ

名前	型	説明
`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 から現在のフォルダにファイルを作成します。

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.getRootFolder().createFile(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)`

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

// 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)`

特定のユーザーに付与されている権限を取得します。

パラメータ

名前	型	説明
`email`	`String`	権限を確認するユーザーのメールアドレス

戻る

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 (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 が、次のセキュリティアップデートの適用対象となるかどうかを取得しますリンクを使用して共有する場合、アクセスのためにリソースキーが必要です。

Google ドライブで共有されたファイルやフォルダにアクセスするには、リソースキーが必要です。表示されます。この変更はセキュリティアップデートの一環です。対象デバイスの場合、アップデートはデフォルトでオンになっています。管理できます。対象となるファイルに対してリソースキーの要件を有効または無効にするには、次のコマンドを使用します。 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 (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)`

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

現在のユーザーは、ファイルのオーナーであるか、アイテムの少なくとも 1 つの編集権限を持っている必要があります現在の親フォルダを変更する必要があります。

パラメータ

名前	型	説明
`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 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.""
var files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var 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 API v2 を使用し、一部のクエリフィールドは v3 と異なります。フィールドを確認 v2 と v3 の違いについての説明をご覧ください。

// Logs the name of every folder that are children of the current folder and you own and is starred.
var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var 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 に対する明示的な編集権限。

パラメータ

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

戻る

Folder - この Folder（チェーン用）

承認

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

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

`setOwner(user)`

Folder のオーナーを変更します。この方法では、以前の所有者にも Folder に対する明示的な編集権限。

パラメータ

名前	型	説明
`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.)
var 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) を使用してください。

指定されたファイルを現在のフォルダに追加します。この方法ではファイルが既存の親フォルダ1 つのファイルに同時に複数の親を設定できます。

パラメータ

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

戻る

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

承認

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

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

`addFolder(child)`

非推奨。代わりに moveTo(destination) または createShortcut(targetId) を使用してください。

指定したフォルダを現在のフォルダに追加します。この方法では、フォルダが新しい既存の親フォルダを作成します1 つのフォルダに同時に複数の親を設定できます。

パラメータ

名前	型	説明
`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