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指定されたドライブ アイテム ID とリソースキーへのショートカットを作成して返します。
getAccess(email)Permission特定のユーザーに付与されている権限を取得します。
getAccess(user)Permission特定のユーザーに付与されている権限を取得します。
getDateCreated()DateFolder が作成された日付を取得します。
getDescription()StringFolder の説明を取得します。
getEditors()User[]この Folder の編集者のリストを取得します。
getFiles()FileIterator現在のフォルダの子であるすべてのファイルのコレクションを取得します。
getFilesByName(name)FileIterator現在のフォルダの子で、指定された名前を持つすべてのファイルのコレクションを取得します。
getFilesByType(mimeType)FileIterator現在のフォルダの子で、指定した MIME タイプのすべてのファイルを取得します。
getFolders()FolderIterator現在のフォルダの子フォルダのコレクションを取得します。
getFoldersByName(name)FolderIterator現在のフォルダの子フォルダで、指定された名前を持つすべてのフォルダのコレクションを取得します。
getId()StringFolder の ID を取得します。
getLastUpdated()DateFolder が最後に更新された日付を取得します。
getName()StringFolder の名前を取得します。
getOwner()Userこの Folder のオーナーを取得します。
getParents()FolderIteratorFolder の直接の親であるフォルダのコレクションを取得します。
getResourceKey()Stringリンクを使用して共有されたアイテムにアクセスするために必要な Folder のリソースキーを取得します。
getSecurityUpdateEligible()Booleanこの Folder が、リンクを使用して共有する際にアクセスにリソースキーを必要とするセキュリティ アップデートを適用できるかどうかを取得します。
getSecurityUpdateEnabled()Booleanこの Folder をリンクを使用して共有するときに、アクセスにリソースキーが必要かどうかを取得します。
getSharingAccess()Access明示的にアクセス権が付与されている個々のユーザーのほかに、Folder にアクセスできるユーザークラスを取得します。
getSharingPermission()PermissionFolder にアクセスできるユーザーに付与されている権限を取得します。明示的にアクセス権が付与されている個々のユーザーは除きます。
getSize()Integerドライブに Folder を保存するために使用されるバイト数を取得します。
getUrl()StringGoogle ドライブや Google ドキュメントなどの Google アプリで Folder を開く際に使用できる URL を取得します。
getViewers()User[]この Folder の閲覧者とコメント投稿者のリストを取得します。
isShareableByEditors()BooleanFolder の編集権限を持つユーザーが、他のユーザーと共有したり、権限を変更したりできるかどうかを決定します。
isStarred()BooleanFolder がユーザーのドライブでスターを付けられているかどうかを判断します。
isTrashed()BooleanFolder がユーザーのドライブのゴミ箱にあるかどうかを判断します。
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)FolderFolder の説明を設定します。
setName(name)FolderFolder の名前を設定します。
setOwner(emailAddress)FolderFolder のオーナーを変更します。
setOwner(user)FolderFolder のオーナーを変更します。
setSecurityUpdateEnabled(enabled)FolderFolder がリンクを使用して共有されるときに、アクセスにリソースキーが必要かどうかを設定します。
setShareableByEditors(shareable)FolderFolder の編集権限を持つユーザーが他のユーザーと共有したり、権限を変更したりできるかどうかを設定します。
setSharing(accessType, permissionType)FolderFolder にアクセスできるユーザークラスと、そのユーザーに付与される権限を設定します。明示的にアクセス権が付与されている個々のユーザーは除きます。
setStarred(starred)FolderFolder がユーザーのドライブでスターを付けられるかどうかを設定します。
setTrashed(trashed)FolderFolder がユーザーのドライブのゴミ箱にあるかどうかを設定します。

詳細なドキュメント

addEditor(emailAddress)

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

パラメータ

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

戻る

Folder - チェーン用の Folder。

承認

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

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

addEditor(user)

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

パラメータ

名前型説明
userUser追加するユーザーを表します。

戻る

Folder - チェーン用の Folder。

承認

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

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

addEditors(emailAddresses)

指定されたユーザーの配列を Folder の編集者のリストに追加します。すでに視聴者のリストに登録されているユーザーは、この方法で視聴者のリストから除外されます。

パラメータ

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

戻る

Folder - チェーン用の Folder。

承認

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

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

addViewer(emailAddress)

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

パラメータ

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

戻る

Folder - チェーン用の Folder。

承認

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

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

addViewer(user)

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

パラメータ

名前型説明
userUser追加するユーザーを表します。

戻る

Folder - チェーン用の Folder。

承認

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

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

addViewers(emailAddresses)

指定されたユーザーの配列を Folder の視聴者のリストに追加します。いずれかのユーザーがすでに編集者のリストに登録されている場合、この方法は適用されません。

パラメータ

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

戻る

Folder - チェーン用の Folder。

承認

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

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

createFile(blob)

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

パラメータ

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

戻る

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!');

パラメータ

名前型説明
nameString新しいファイルの名前。
contentString新しいファイルの内容。

戻る

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);

パラメータ

名前型説明
nameString新しいファイルの名前。
contentString新しいファイルの内容。
mimeTypeString新しいファイルの MIME タイプ。

戻る

File - 新しいファイル。

承認

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

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

createFolder(name)

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

パラメータ

名前型説明
nameString新しいフォルダの名前。

戻る

Folder - 新しいフォルダ。

承認

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

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

createShortcut(targetId)

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

パラメータ

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

戻る

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

承認

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

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

指定されたドライブ アイテム 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(),
  );
}

パラメータ

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

戻る

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

承認

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

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

getAccess(email)

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

パラメータ

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

戻る

Permission - ユーザーに付与されている権限。

承認

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

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

getAccess(user)

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

パラメータ

名前型説明
userUser権限を確認するユーザーを表すオブジェクト。

戻る

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)

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

パラメータ

名前型説明
nameString検索するファイルの名前。

戻る

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

承認

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

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

getFilesByType(mimeType)

現在のフォルダの子で、指定した MIME タイプのすべてのファイルを取得します。

パラメータ

名前型説明
mimeTypeString検索するファイルの 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)

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

パラメータ

名前型説明
nameString検索するフォルダの名前。

戻る

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 ドライブや Google ドキュメントなどの Google アプリで Folder を開く際に使用できる URL を取得します。

戻る

String - Google ドライブや Google ドキュメントなどの 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)

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

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

パラメータ

名前型説明
destinationFolder新しい親となるフォルダ。

戻る

Folder - チェーン用の Folder。

承認

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

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

removeEditor(emailAddress)

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

ドライブ ファイルの場合、この操作により、ユーザーは閲覧者のリストからも削除されます。

パラメータ

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

戻る

Folder - チェーン用の Folder。

承認

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

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

removeEditor(user)

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

ドライブ ファイルの場合、この操作により、ユーザーは閲覧者のリストからも削除されます。

パラメータ

名前型説明
userUser削除するユーザーを表す。

戻る

Folder - チェーン用の Folder。

承認

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

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

removeViewer(emailAddress)

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

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

パラメータ

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

戻る

Folder - チェーン用の Folder。

承認

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

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

removeViewer(user)

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

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

パラメータ

名前型説明
userUser削除するユーザーを表す。

戻る

Folder - チェーン用の Folder。

承認

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

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

revokePermissions(emailAddress)

指定されたユーザーに付与された Folder へのアクセス権を取り消します。この方法では、Folder がユーザーのドメイン全体と共有されている場合など、一般的なアクセス権を持つユーザークラスに属しているユーザーが Folder にアクセスできないようにはなりません。

パラメータ

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

戻る

Folder - チェーン用の Folder。

承認

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

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

revokePermissions(user)

指定されたユーザーに付与された Folder へのアクセス権を取り消します。この方法では、Folder がユーザーのドメイン全体と共有されている場合など、一般的なアクセス権を持つユーザークラスに属しているユーザーが Folder にアクセスできないようにはなりません。

パラメータ

名前型説明
userUserアクセス権を取り消すユーザーを表します。

戻る

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());
}

パラメータ

名前型説明
paramsString検索条件（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 のフィールドの違いを確認します。

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

// 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());
}

パラメータ

名前型説明
paramsString検索条件（Google Drive SDK のドキュメントで詳細をご確認ください）。

戻る

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

承認

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

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

setDescription(description)

Folder の説明を設定します。

パラメータ

名前型説明
descriptionStringFolder の新しい説明

戻る

Folder - チェーン用の this Folder

承認

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

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

setName(name)

Folder の名前を設定します。

パラメータ

名前型説明
nameStringFolder の新しい名前

戻る

Folder - チェーン用の this Folder

承認

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

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

setOwner(emailAddress)

Folder のオーナーを変更します。この方法では、以前のオーナーに Folder に対する明示的な編集アクセス権も付与されます。

パラメータ

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

戻る

Folder - チェーン用の this Folder

承認

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

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

setOwner(user)

Folder のオーナーを変更します。この方法では、以前のオーナーに Folder に対する明示的な編集アクセス権も付与されます。

パラメータ

名前型説明
userUser新しいオーナーになるユーザーの表現

戻る

Folder - チェーン用の this Folder

承認

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

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

setSecurityUpdateEnabled(enabled)

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

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

パラメータ

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

戻る

Folder - チェーン用の Folder。

承認

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

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

setShareableByEditors(shareable)

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

パラメータ

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

戻る

Folder - チェーン用の this 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);

パラメータ

名前型説明
accessTypeAccessFolder にアクセスできるユーザーのクラス
permissionTypePermissionFolder にアクセスできるユーザーに付与する必要がある権限

戻る

Folder - チェーン用の this Folder

承認

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

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

setStarred(starred)

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

パラメータ

名前型説明
starredBooleanFolder をユーザーのドライブでスターを付ける必要がある場合は true、そうでない場合は false

戻る

Folder - チェーン用の this Folder

承認

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

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

setTrashed(trashed)

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

パラメータ

名前型説明
trashedBooleanFolder をユーザーのドライブのゴミ箱に移動する必要がある場合は true、そうでない場合は false

戻る

Folder - チェーン用の this Folder

承認

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

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

サポート終了のメソッド