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` 是否已加上星號。
`setTrashed(trashed)`	`Folder`	設定 `Folder` 是否位於使用者雲端硬碟的垃圾桶中。

已淘汰的方法

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

內容詳盡的說明文件

`addEditor(emailAddress)`

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

參數

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

回攻員

Folder - This Folder，用於鏈結。

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`addEditor(user)`

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

參數

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

回攻員

Folder — This Folder, for chaining.

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`addEditors(emailAddresses)`

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

參數

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

回攻員

Folder - This Folder，用於鏈結。

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`addViewer(emailAddress)`

將指定使用者新增至 Folder 的檢視者清單。如果使用者已在編輯者名單中，這個方法不會有任何作用。

參數

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

回攻員

Folder — This Folder, for chaining.

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`addViewer(user)`

將指定使用者新增至 Folder 的檢視者清單。如果使用者已在編輯者名單中，這個方法不會有任何作用。

參數

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

回攻員

Folder — This Folder, for chaining.

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`addViewers(emailAddresses)`

將指定的使用者陣列新增至 Folder 的檢視者清單。如果使用者已在編輯者清單中，這個方法對他們不會有任何影響。

參數

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

回攻員

Folder - This 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 應用程式檔案不會計入雲端硬碟儲存空間限制，因此會傳回 0 位元組。

回攻員

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

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

`getUrl()`

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

回攻員

String：可用於在 Google 雲端硬碟或 Google 文件等 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：true 如果 Folder 位於使用者雲端硬碟的垃圾桶中； false 如果不是

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`moveTo(destination)`

將這個項目移至提供的目標資料夾。

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

參數

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

回攻員

Folder — This Folder, for chaining.

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`removeEditor(emailAddress)`

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

如果是雲端硬碟檔案，系統也會從檢視者清單中移除使用者。

參數

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

回攻員

Folder — This Folder, for chaining.

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`removeEditor(user)`

如果是雲端硬碟檔案，系統也會從檢視者清單中移除使用者。

參數

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

回攻員

Folder - This 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 — This Folder, for chaining.

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`revokePermissions(user)`

參數

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

回攻員

Folder — This Folder, for chaining.

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`searchFiles(params)`

取得目前資料夾中符合指定搜尋條件的所有子項檔案集合。如需搜尋條件的詳細資訊，請參閱 Google 雲端硬碟 SDK 說明文件。請注意，Google 雲端硬碟服務使用的是 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 雲端硬碟 SDK 說明文件。

回攻員

FileIterator：目前資料夾中符合搜尋條件的所有子檔案集合。

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`searchFolders(params)`

取得目前資料夾的所有子項資料夾，並比對指定的搜尋條件。如需搜尋條件的詳細資訊，請參閱 Google 雲端硬碟 SDK 說明文件。請注意，Google 雲端硬碟服務使用的是 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 雲端硬碟 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 的明確編輯權限。

雲端硬碟不支援變更 gmail.com 帳戶擁有的項目，但支援 Workspace 帳戶。

參數

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

回攻員

Folder — This Folder, for chaining.

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`setOwner(user)`

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

雲端硬碟不支援變更 gmail.com 帳戶擁有的項目，但支援 Workspace 帳戶。

參數

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

回攻員

Folder — This Folder, for chaining.

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`setSecurityUpdateEnabled(enabled)`

設定 Folder 是否需要資源金鑰才能透過連結存取。系統預設會為符合資格的檔案和資料夾啟用這項功能。

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

參數

名稱	類型	說明
`enabled`	`Boolean`	是否要為 `Folder` 啟用資源金鑰規定。

回攻員

Folder — This Folder, for chaining.

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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 是否已加上星號。新 Folder 的預設值為 false。

參數

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

回攻員

Folder - 這是 Folder，用於鏈結

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`setTrashed(trashed)`

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

參數

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

回攻員

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

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

參數

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

回攻員

Folder：子項的前一個父項。

授權

使用這個方法的指令碼需要透過下列一或多個範圍授權：

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

`removeFolder(child)`

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

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

參數

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

回攻員

Folder：子項的前一個父項。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權：

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

Class Folder 透過集合功能整理內容 你可以依據偏好儲存及分類內容。

方法

已淘汰的方法

內容詳盡的說明文件

addEditor(emailAddress)

參數

回攻員

授權

addEditor(user)

參數

回攻員

授權

addEditors(emailAddresses)

參數

回攻員

授權

addViewer(emailAddress)

參數

回攻員

授權

addViewer(user)

參數

回攻員

授權

addViewers(emailAddresses)

參數

回攻員

授權

createFile(blob)

參數

回攻員

授權

createFile(name, content)

參數

回攻員

授權

createFile(name, content, mimeType)

參數

回攻員

授權

createFolder(name)

參數

回攻員

授權

createShortcut(targetId)

參數

回攻員

授權

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

參數

回攻員

授權

getAccess(email)

參數

回攻員

授權

getAccess(user)

參數

回攻員

授權

getDateCreated()

回攻員

授權

getDescription()

回攻員

授權

getEditors()

回攻員

授權

getFiles()

回攻員

授權

getFilesByName(name)

參數

回攻員

授權

getFilesByType(mimeType)

參數

回攻員

授權

Class Folder

`addEditor(emailAddress)`

`addEditor(user)`

`addEditors(emailAddresses)`

`addViewer(emailAddress)`

`addViewer(user)`

`addViewers(emailAddresses)`

`createFile(blob)`

`createFile(name, content)`

`createFile(name, content, mimeType)`

`createFolder(name)`

`createShortcut(targetId)`

`createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)`

`getAccess(email)`

`getAccess(user)`

`getDateCreated()`

`getDescription()`

`getEditors()`

`getFiles()`

`getFilesByName(name)`

`getFilesByType(mimeType)`

`getFolders()`

`getFoldersByName(name)`

`getId()`

`getLastUpdated()`

`getName()`

`getOwner()`

`getParents()`

`getResourceKey()`

`getSecurityUpdateEligible()`

`getSecurityUpdateEnabled()`

`getSharingAccess()`

`getSharingPermission()`

`getSize()`

`getUrl()`

`getViewers()`

`isShareableByEditors()`

`isStarred()`

`isTrashed()`

`moveTo(destination)`

`removeEditor(emailAddress)`

`removeEditor(user)`

`removeViewer(emailAddress)`