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

Methods

メソッド戻り値の型概要
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()Permission明示的にアクセス権が付与されている個々のユーザーに加え、Folder にアクセスできるユーザーに付与されている権限を取得します。
getSize()Integerドライブに Folder を保存するために使用されるバイト数を取得します。
getUrl()Stringドライブやドキュメントなどの Google アプリで Folder を開くために使用できる URL を取得します。
getViewers()User[]この Folder の閲覧者とコメント投稿者のリストを取得します。
isShareableByEditors()BooleanFolder に対する編集権限を持つユーザーに、他のユーザーと共有したり、権限を変更したりできるかどうかを決定します。
isStarred()Booleanユーザーのドライブで Folder にスターが付いているかどうかを判断します。
isTrashed()BooleanFolder がユーザーのドライブのゴミ箱にあるかどうかを判断します。
moveTo(destination)Folder指定された移動先のフォルダにこのアイテムを移動します。
removeEditor(emailAddress)FolderFolder の編集者のリストから指定されたユーザーを削除します。
removeEditor(user)FolderFolder の編集者のリストから指定されたユーザーを削除します。
removeViewer(emailAddress)FolderFolder の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
removeViewer(user)FolderFolder の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
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)Folderリンクを使用して共有される場合、Folder がアクセスのためにリソースキーを必要とするかどうかを設定します。
setShareableByEditors(shareable)FolderFolder の編集権限を持つユーザーに、他のユーザーとの共有や権限の変更を許可するかどうかを設定します。
setSharing(accessType, permissionType)Folder明示的にアクセス権を付与された個々のユーザーに加えて、Folder にアクセスできるユーザーのクラスと、これらのユーザーに付与される権限を設定します。
setStarred(starred)Folderユーザーのドライブで Folder にスターを付けるかどうかを設定します。
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 から現在のフォルダにファイルを作成します。

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

パラメータ

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

指定されたユーザーに付与された権限を取得します。

パラメータ

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

リターン

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

承認

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

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

getAccess(user)

指定されたユーザーに付与された権限を取得します。

パラメータ

名前説明
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 (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 アプリで 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)

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

アイテムを移動先フォルダに移動するには、現在のユーザーがファイルのオーナーであるか、少なくともアイテムの現在の親フォルダに対する編集権限が必要です。

パラメータ

名前説明
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 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());
}

パラメータ

名前説明
paramsString検索条件。詳細は Google ドライブ 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 のフィールドの違いを確認してください。

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.
var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  console.log(folder.getName());
}

パラメータ

名前説明
paramsString検索条件。詳細は Google ドライブ SDK のドキュメントをご覧ください。

リターン

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

承認

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

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

setDescription(description)

Folder の説明を設定します。

パラメータ

名前説明
descriptionStringFolder の新しい説明

リターン

Folder - この Folder(チェーン用)

承認

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

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

setName(name)

Folder の名前を設定します。

パラメータ

名前説明
nameStringFolder の新しい名前

リターン

Folder - この Folder(チェーン用)

承認

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

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

setOwner(emailAddress)

Folder のオーナーを変更します。このメソッドでは、前のオーナーに Folder に対する明示的な編集権限も付与されます。

パラメータ

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

リターン

Folder - この Folder(チェーン用)

承認

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

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

setOwner(user)

Folder のオーナーを変更します。このメソッドでは、前のオーナーに Folder に対する明示的な編集権限も付与されます。

パラメータ

名前説明
userUser新しいオーナーになるユーザーを表します。

リターン

Folder - この 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 です。

パラメータ

名前説明
shareableBoolean編集権限を持つユーザーに、他のユーザーとの共有または権限の変更を許可する場合は 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);

パラメータ

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

リターン

Folder - この Folder(チェーン用)

承認

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

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

setStarred(starred)

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

パラメータ

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

リターン

Folder - この Folder(チェーン用)

承認

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

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

setTrashed(trashed)

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

パラメータ

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

リターン

Folder - この Folder(チェーン用)

承認

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

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

サポート終了のメソッド