本頁面由 Cloud Translation API 翻譯而成。

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()`	`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 應用程式 (例如雲端硬碟或 Google 文件) 中開啟 `Folder` 的網址。
`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` 是否已在使用者的 Google 雲端硬碟中加星號。
`setTrashed(trashed)`	`Folder`	設定 `Folder` 是否位於使用者雲端硬碟的垃圾桶中。

已淘汰的方法

方法	傳回類型	簡短說明
`addFile(child)`	`Folder`	將指定檔案新增至目前資料夾。
`addFolder(child)`	`Folder`	將指定的資料夾新增至目前的資料夾。
`removeFile(child)`	`Folder`	從目前的資料夾移除指定檔案。
`removeFolder(child)`	`Folder`	從目前的資料夾中移除指定的資料夾。

內容詳盡的說明文件

`addEditor(emailAddress)`

將指定使用者新增至 Folder 的編輯者清單。如果使用者已在觀看者名單中，這個方法會將使用者從觀看者名單中移除。

參數

名稱	類型	說明
`emailAddress`	`String`	要新增的使用者電子郵件地址。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`addEditor(user)`

將指定使用者新增至 Folder 的編輯者清單。如果使用者已在觀看者名單中，這個方法會將使用者從觀看者名單中移除。

參數

名稱	類型	說明
`user`	`User`	要新增的使用者代表。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`addEditors(emailAddresses)`

將指定的使用者陣列新增至 Folder 的編輯者清單。如果有任何使用者已在觀眾名單中，這個方法會將他們從觀眾名單中移除。

參數

名稱	類型	說明
`emailAddresses`	`String[]`	要新增的使用者電子郵件地址陣列。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`addViewer(emailAddress)`

將指定使用者新增至 Folder 的觀眾名單。如果使用者已在編輯者名單中，這個方法就不會生效。

參數

名稱	類型	說明
`emailAddress`	`String`	要新增的使用者電子郵件地址。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`addViewer(user)`

將指定使用者新增至 Folder 的觀眾名單。如果使用者已在編輯者名單中，這個方法就不會生效。

參數

名稱	類型	說明
`user`	`User`	要新增的使用者代表。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`addViewers(emailAddresses)`

將指定的使用者陣列新增至 Folder 的觀眾清單。如果有任何使用者已在編輯者清單中，則此方法對他們不會產生任何效果。

參數

名稱	類型	說明
`emailAddresses`	`String[]`	要新增的使用者電子郵件地址陣列。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`createFile(blob)`

使用任意資料的指定 Blob，在目前資料夾中建立檔案。

參數

名稱	類型	說明
`blob`	`BlobSource`	新檔案的資料。

回攻員

File：新檔案。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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：新檔案。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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：新檔案。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`createFolder(name)`

在目前資料夾中建立名稱為指定名稱的資料夾。

參數

名稱	類型	說明
`name`	`String`	新資料夾的名稱。

回攻員

Folder：新資料夾。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`createShortcut(targetId)`

建立並傳回指定雲端硬碟項目 ID 的捷徑。

參數

名稱	類型	說明
`targetId`	`String`	目標檔案或資料夾的檔案 ID。

回攻員

File：新的捷徑。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

參數

名稱	類型	說明
`targetId`	`String`	目標檔案或資料夾的 ID。
`targetResourceKey`	`String`	目標檔案或資料夾的資源鍵。

回攻員

File：新的捷徑。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getAccess(email)`

取得授予特定使用者的權限。這個方法不支援傳回 Google 群組的權限，或透過 Google 群組繼承的權限。

參數

名稱	類型	說明
`email`	`String`	需要檢查權限的使用者電子郵件地址。不支援 Google 網路論壇。

回攻員

Permission：授予使用者的權限。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getAccess(user)`

取得授予特定使用者的權限。這個方法不支援傳回 Google 群組的權限，或透過 Google 群組繼承的權限。

參數

名稱	類型	說明
`user`	`User`	代表應檢查權限的使用者。

回攻員

Permission：授予使用者的權限。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getDateCreated()`

取得 Folder 的建立日期。

回攻員

Date：Folder 建立的日期

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getDescription()`

取得 Folder 的說明。

回攻員

String：Folder 的說明

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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 的編輯者清單；否則為空 آرایه.

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getFiles()`

取得目前資料夾的所有子項檔案集合。

回攻員

FileIterator：目前資料夾的所有子項檔案集合。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getFilesByName(name)`

取得目前資料夾的子項，以及具有指定名稱的所有檔案集合。

參數

名稱	類型	說明
`name`	`String`	要尋找的檔案名稱。

回攻員

FileIterator：收集目前資料夾的子項，且具有指定名稱的所有檔案。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getFilesByType(mimeType)`

取得目前資料夾的子項，以及具有指定 MIME 類型的所有檔案集合。

參數

名稱	類型	說明
`mimeType`	`String`	要尋找的檔案 MIME 類型。

回攻員

FileIterator：收集目前資料夾的子項，且具有指定 MIME 類型的所有檔案。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getFolders()`

取得目前資料夾的所有子資料夾集合。

回攻員

FolderIterator：目前資料夾的所有子項資料夾集合。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getFoldersByName(name)`

取得目前資料夾的所有子資料夾集合，且具有指定名稱。

參數

名稱	類型	說明
`name`	`String`	要尋找的資料夾名稱。

回攻員

FolderIterator：目前資料夾的子資料夾集合，且具有指定名稱。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getId()`

取得 Folder 的 ID。

回攻員

String：Folder 的 ID

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getLastUpdated()`

取得 Folder 上次更新的日期。

回攻員

Date：Folder上次更新的日期

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getName()`

取得 Folder 的名稱。

回攻員

String：Folder 的名稱

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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 的擁有者。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getParents()`

取得 Folder 的直接父項資料夾集合。

回攻員

FolderIterator：Folder 的直屬父項資料夾集合

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getResourceKey()`

取得 Folder 的資源鍵，該鍵是存取使用連結共用項目所需的項目。

回攻員

String：Folder 的資源鍵。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getSecurityUpdateEligible()`

取得這個 Folder 是否符合套用安全性更新的資格。當檔案透過連結共用時，需要提供資源金鑰才能存取。

雲端硬碟需要資源金鑰，才能存取使用連結共用的部分檔案或資料夾。這項變更是安全性更新的一部分。系統會預設為符合資格的檔案和資料夾啟用更新功能。如要針對符合資格的檔案開啟或關閉資源金鑰需求，請使用 setSecurityUpdateEnabled。

進一步瞭解 Google 雲端硬碟安全性更新。

回攻員

Boolean：資源鍵需求是否可套用至 Folder。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getSecurityUpdateEnabled()`

取得這個 Folder 在使用連結分享時，是否需要資源索引鍵才能存取。系統預設會為符合資格的檔案和資料夾啟用這項要求。如要針對符合資格的檔案開啟或關閉資源金鑰需求，請使用 setSecurityUpdateEnabled。

進一步瞭解 Google 雲端硬碟安全性更新。

回攻員

Boolean：是否為此 Folder 啟用資源鍵需求。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getSharingAccess()`

除了明確授予存取權的個別使用者之外，取得可存取 Folder 的使用者類別。

回攻員

Access：哪些使用者類別可以存取 Folder

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getSharingPermission()`

除了明確授予存取權的個別使用者之外，還可取得授予 Folder 存取權的使用者所擁有的權限。

回攻員

Permission：授予可存取 Folder 的使用者權限

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getSize()`

取得用於在雲端硬碟中儲存 Folder 的位元組數。請注意，Google Workspace 應用程式檔案不會計入 Google 雲端硬碟儲存空間限制，因此會傳回 0 位元組。

回攻員

Integer：在雲端硬碟中儲存 Folder 所需的位元組數

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`getUrl()`

取得可用於在 Google 應用程式 (例如雲端硬碟或 Google 文件) 中開啟 Folder 的網址。

回攻員

String：可用於在 Google 應用程式 (例如雲端硬碟或文件) 中查看此 Folder 的網址

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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 的觀看者和加註者清單；否則為空 آرایه.

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`isShareableByEditors()`

判斷具有 Folder 編輯權限的使用者是否可以與其他使用者共用或變更權限。

回攻員

Boolean：如果具備編輯權限的使用者可以與其他使用者共用或變更權限，則為 true；否則為 false

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`isStarred()`

判斷 Folder 是否已在使用者的雲端硬碟中加星號。

回攻員

Boolean：如果 Folder 在使用者的雲端硬碟中加上星號，則為 true；否則為 false

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`isTrashed()`

判斷 Folder 是否位於使用者的雲端硬碟垃圾桶中。

回攻員

Boolean：如果 Folder 位於使用者的雲端硬碟垃圾桶中，則為 true；否則為 false

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`moveTo(destination)`

將這個項目移至指定的目標資料夾。

如要將項目移至目的地資料夾，目前使用者必須是檔案的擁有者，或至少擁有項目目前上層資料夾的編輯存取權。

參數

名稱	類型	說明
`destination`	`Folder`	成為新父項的資料夾。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`removeEditor(emailAddress)`

將指定使用者從 Folder 的編輯者清單中移除。如果使用者屬於擁有一般存取權的使用者類別，這項方法就不會阻止使用者存取 Folder，例如 Folder 與使用者的整個網域共用，或是 Folder 位於使用者可存取的共用雲端硬碟中。

對於雲端硬碟檔案，這也會將使用者從檢視者清單中移除。

參數

名稱	類型	說明
`emailAddress`	`String`	要移除的使用者電子郵件地址。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`removeEditor(user)`

對於雲端硬碟檔案，這也會將使用者從檢視者清單中移除。

參數

名稱	類型	說明
`user`	`User`	要移除的使用者。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`removeViewer(emailAddress)`

將指定使用者從 Folder 的觀眾和留言者名單中移除。如果使用者是編輯者，而非觀眾或評論者，則這個方法不會生效。使用者如果屬於具有一般存取權的使用者類別，這項方法也不會阻止使用者存取 Folder，例如 Folder 與使用者的整個網域共用，或是 Folder 位於使用者可存取的共用雲端硬碟中。

對於雲端硬碟檔案，這也會將使用者從編輯者清單中移除。

參數

名稱	類型	說明
`emailAddress`	`String`	要移除的使用者電子郵件地址。

回攻員

Folder：用於鏈結的 Folder。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`removeViewer(user)`

將指定使用者從 Folder 的觀眾和留言者名單中移除。如果使用者是編輯者而非觀眾，這個方法就不會生效。如果使用者屬於具有一般存取權的使用者類別，這項方法也不會阻止使用者存取 Folder，例如 Folder 與使用者的整個網域共用，或是 Folder 位於使用者可存取的共用雲端硬碟中。

對於雲端硬碟檔案，這也會將使用者從編輯者清單中移除。

參數

名稱	類型	說明
`user`	`User`	要移除的使用者。

回攻員

Folder：用於鏈結的 Folder。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`revokePermissions(emailAddress)`

撤銷對特定使用者授予的 Folder 存取權。如果使用者屬於具有一般存取權的使用者類別，這個方法就不會阻止使用者存取 Folder，例如，如果 Folder 與使用者的整個網域共用。

參數

名稱	類型	說明
`emailAddress`	`String`	需要撤銷存取權的使用者電子郵件地址。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`revokePermissions(user)`

參數

名稱	類型	說明
`user`	`User`	應撤銷存取權的使用者。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`searchFiles(params)`

取得目前資料夾的子項，以及符合指定搜尋條件的所有檔案集合。如要進一步瞭解搜尋條件，請參閱 Google 雲端硬碟 SDK 說明文件。請注意，Drive 服務使用的是 Drive API 第 2 版，因此部分查詢欄位與第 3 版不同。查看 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：收集目前資料夾的子項，且符合搜尋條件的所有檔案。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`searchFolders(params)`

取得目前資料夾的所有子資料夾集合，且符合指定的搜尋條件。如要進一步瞭解搜尋條件，請參閱 Google 雲端硬碟 SDK 說明文件。請注意，Drive 服務使用的是 Drive API 第 2 版，因此部分查詢欄位與第 3 版不同。查看 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());
}

參數

名稱	類型	說明
`params`	`String`	搜尋條件，詳情請參閱 Google Drive SDK 說明文件。

回攻員

FolderIterator：收集目前資料夾的所有子資料夾，且符合搜尋條件。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setDescription(description)`

設定 Folder 的說明。

參數

名稱	類型	說明
`description`	`String`	`Folder` 的新說明

回攻員

Folder — 這個 Folder，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setName(name)`

設定 Folder 的名稱。

參數

名稱	類型	說明
`name`	`String`	`Folder` 的新名稱

回攻員

Folder — 這個 Folder，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setOwner(emailAddress)`

變更 Folder 的擁有者。這個方法也會將 Folder 的明確編輯存取權授予先前的擁有者。

參數

名稱	類型	說明
`emailAddress`	`String`	將成為新擁有者的使用者電子郵件地址

回攻員

Folder — 這個 Folder，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setOwner(user)`

變更 Folder 的擁有者。這個方法也會將 Folder 的明確編輯存取權授予先前的擁有者。

參數

名稱	類型	說明
`user`	`User`	代表應成為新擁有者的使用者

回攻員

Folder — 這個 Folder，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setSecurityUpdateEnabled(enabled)`

設定 Folder 是否需要使用資源索引鍵存取權，以便透過連結共用。符合資格的檔案和資料夾預設為啟用。

進一步瞭解 Google 雲端硬碟安全性更新。

參數

名稱	類型	說明
`enabled`	`Boolean`	是否為 `Folder` 啟用資源鍵需求。

回攻員

Folder：這個 Folder，用於鏈結。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setShareableByEditors(shareable)`

設定是否允許具備 Folder 編輯權限的使用者與其他使用者共用或變更權限。新 Folder 的預設值為 true。

參數

名稱	類型	說明
`shareable`	`Boolean`	`true` 如果允許具備編輯權限的使用者與其他使用者共用或變更權限；`false`如果不允許

回攻員

Folder — 這個 Folder，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setStarred(starred)`

設定 Folder 是否在使用者的 Google 雲端硬碟中標為星號。新 Folder 的預設值為 false。

參數

名稱	類型	說明
`starred`	`Boolean`	如果 `Folder` 應在使用者的雲端硬碟中加上星號，請傳回 `true`；如果不應加上星號，則傳回 `false`

回攻員

Folder — 這個 Folder，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`setTrashed(trashed)`

設定 Folder 是否位於使用者雲端硬碟的垃圾桶中。只有擁有者可以將 Folder 丟進垃圾桶。新 Folder 的預設值為 false。

參數

名稱	類型	說明
`trashed`	`Boolean`	`true`：如果 `Folder` 應移至使用者雲端硬碟的垃圾桶；`false`：如果不應移至垃圾桶

回攻員

Folder — 這個 Folder，用於鏈結

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

已淘汰的方法

`addFile(child)`

已淘汰。請改用 File.moveTo(destination) 或 createShortcut(targetId)。

將指定檔案新增至目前資料夾。這個方法不會將檔案從現有上層資料夾移出；檔案可同時有多個父項。

參數

名稱	類型	說明
`child`	`File`	要新增的子檔案。

回攻員

Folder：新增的父項檔案，做為子項新增。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`addFolder(child)`

已淘汰。請改用 moveTo(destination) 或 createShortcut(targetId)。

將指定的資料夾新增至目前的資料夾。這個方法不會將資料夾移出現有父項資料夾；資料夾可同時擁有多個父項。

參數

名稱	類型	說明
`child`	`Folder`	要新增的子資料夾。

回攻員

Folder：新增的父項資料夾，會以子項新增。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`removeFile(child)`

已淘汰。而是改用 File.moveTo(destination)。

從目前的資料夾移除指定檔案。這個方法不會刪除檔案，但如果檔案從所有父項中移除，就無法在 Google 雲端硬碟中顯示，除非使用搜尋功能或「所有項目」檢視畫面。

參數

名稱	類型	說明
`child`	`File`	要移除的子檔案。

回攻員

Folder：子項的上一個父項。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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

`removeFolder(child)`

已淘汰。而是改用 moveTo(destination)。

從目前的資料夾中移除指定的資料夾。這個方法不會刪除資料夾或其內容，但如果資料夾從所有上層資料夾中移除，就無法在 Google 雲端硬碟中顯示，除非使用搜尋功能或「所有項目」檢視畫面。

參數

名稱	類型	說明
`child`	`Folder`	要移除的子資料夾。

回攻員

Folder：子項的上一個父項。

授權

使用這個方法的腳本需要具備下列一或多個範圍的授權：

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