Class Folder

資料夾

Google 雲端硬碟中的資料夾。你可以前往 DriveApp存取或建立資料夾。 

// Log the name of every folder in the user's Drive.
var folders = DriveApp.getFolders();
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.log(folder.getName());
}

方法

方法傳回類型簡短說明
addEditor(emailAddress)Folder將特定使用者新增至 Folder 的編輯者清單。
addEditor(user)Folder將特定使用者新增至 Folder 的編輯者清單。
addEditors(emailAddresses)Folder將指定的使用者陣列新增至 Folder 的編輯者清單。
addViewer(emailAddress)Folder將特定使用者新增至 Folder 的檢視者清單。
addViewer(user)Folder將特定使用者新增至 Folder 的檢視者清單。
addViewers(emailAddresses)Folder將指定的使用者陣列新增至 Folder 的檢視者清單。
createFile(blob)File從指定的任意資料的 Blob 在目前的資料夾中建立檔案。
createFile(name, content)File以指定的名稱和內容在目前的資料夾中建立文字檔案。
createFile(name, content, mimeType)File以指定名稱、內容和 MIME 類型在目前的資料夾中建立檔案。
createFolder(name)Folder在目前的資料夾中以指定名稱建立資料夾。
createShortcut(targetId)File建立並傳回所提供雲端硬碟項目 ID 的捷徑。
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)File建立並傳回所提供雲端硬碟項目 ID 和資源金鑰的捷徑。
getAccess(email)Permission取得授予指定使用者的權限。
getAccess(user)Permission取得授予指定使用者的權限。
getDateCreated()Date取得 Folder 的建立日期。
getDescription()String取得 Folder 的說明。
getEditors()User[]取得這個 Folder 的編輯者清單。
getFiles()FileIterator取得目前資料夾所有子檔案的集合。
getFilesByName(name)FileIterator取得目前資料夾子項，且具有指定名稱的所有檔案的集合。
getFilesByType(mimeType)FileIterator取得目前資料夾的子項，且具有指定 MIME 類型的所有檔案的集合。
getFolders()FolderIterator取得目前資料夾子項的所有資料夾集合。
getFoldersByName(name)FolderIterator取得目前資料夾的子項，且具有指定名稱的所有資料夾集合。
getId()String取得 Folder 的 ID。
getLastUpdated()Date取得 Folder 上次更新日期。
getName()String取得 Folder 的名稱。
getOwner()User取得這個 Folder 的擁有者。
getParents()FolderIterator取得一組資料夾，這些資料夾是 Folder 的直接父項。
getResourceKey()String取得存取 Folder 所需的項目所需的資源金鑰 已經透過連結分享。
getSecurityUpdateEligible()Boolean確認這部Folder是否符合套用安全性更新的 透過連結共用時，需要資源金鑰才能存取。
getSecurityUpdateEnabled()Boolean取得在適當情況下，這個 Folder 是否需要資源金鑰才能存取 透過連結分享。
getSharingAccess()Access取得有權存取 Folder 的使用者類別 (除了個別使用者外) 獲得明確授予存取權的使用者。
getSharingPermission()Permission取得權限授予有權存取 Folder 的使用者。 向任何已明確授予存取權的使用者除外。
getSize()Integer取得在雲端硬碟中儲存 Folder 的位元組數。
getUrl()String取得可在 Google 應用程式中開啟 Folder 的網址，例如： Google 雲端硬碟或文件。
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 是否位於使用者雲端硬碟的垃圾桶中。

內容詳盡的說明文件

addEditor(emailAddress)

將特定使用者新增至 Folder 的編輯者清單。如果使用者已 觀眾也會成為觀眾，因此能在觀影迷清單中向他們宣傳。

參數

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

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

addEditor(user)

將特定使用者新增至 Folder 的編輯者清單。如果使用者已 觀眾也會成為觀眾，因此能在觀影迷清單中向他們宣傳。

參數

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

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

addEditors(emailAddresses)

將指定的使用者陣列新增至 Folder 的編輯者清單。如果有任何 觀看清單中的使用者，這種做法是將他們 觀眾。

參數

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

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

addViewer(emailAddress)

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

參數

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

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

addViewer(user)

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

參數

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

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

addViewers(emailAddresses)

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

參數

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

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

授權

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

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

授權

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

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

授權

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

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

createFolder(name)

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

參數

名稱類型說明
nameString新資料夾的名稱。

回攻員

Folder：新資料夾。

授權

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

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

createShortcut(targetId)

建立並傳回所提供雲端硬碟項目 ID 的捷徑。

參數

名稱類型說明
targetIdString目標檔案或資料夾的檔案 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());
}

參數

名稱類型說明
targetIdString目標檔案或資料夾的 ID。
targetResourceKeyString目標檔案或資料夾的資源金鑰。

回攻員

File：新的捷徑。

授權

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

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

getAccess(email)

取得授予指定使用者的權限。

參數

名稱類型說明
emailString應檢查其權限的使用者電子郵件地址

回攻員

Permission：授予使用者的權限

授權

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

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

getAccess(user)

取得授予指定使用者的權限。

參數

名稱類型說明
userUser代表應檢查其權限的使用者

回攻員

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

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

參數

名稱類型說明
nameString要尋找的檔案名稱。

回攻員

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

授權

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

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

getFilesByType(mimeType)

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

參數

名稱類型說明
mimeTypeString要尋找的檔案 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)

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

參數

名稱類型說明
nameString要尋找的資料夾名稱。

回攻員

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是否符合套用安全性更新的 透過連結共用時，需要資源金鑰才能存取。

Google 雲端硬碟需要資源金鑰，才能存取某些透過 Google 帳戶共用的檔案或資料夾 連結。這項異動是安全性更新的一部分。更新預設會啟用 檔案與資料夾如要為符合資格的檔案開啟或關閉資源金鑰規定，請使用 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 應用程式中開啟 Folder 的網址，例如： Google 雲端硬碟或文件。

回攻員

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

授權

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

  • 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 的檢視者和加註者清單 (如果使用者有編輯權限) 否則就會傳回空陣列

授權

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

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

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

目前的使用者必須是檔案擁有者，或是至少具備這個項目的編輯權限 以便將項目移至目標資料夾。

參數

名稱類型說明
destinationFolder做為新父項的資料夾。

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

removeEditor(emailAddress)

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

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

參數

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

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

removeEditor(user)

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

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

參數

名稱類型說明
userUser要移除的使用者表示法。

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

removeViewer(emailAddress)

將特定使用者從 Folder 的檢視者和加註者清單中移除。這個 如果使用者是編輯者，而不是檢視者或加註者，此方法不會生效。這個方法 無法禁止隸屬於特定類別的使用者存取 Folder 但具備一般存取權，例如將 Folder 與使用者的 或是使用者可以存取的共用雲端硬碟中，就刪除 Folder。

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

參數

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

回攻員

Folder：這個 Folder 用於鏈結。

授權

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

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

removeViewer(user)

將特定使用者從 Folder 的檢視者和加註者清單中移除。這個 如果使用者是編輯者，而不是檢視者，此方法不會有任何作用。這個方法也不會 如果使用者屬於一般使用者的類別，就無法存取 Folder 存取權，例如 Folder 已與整個網域共用 如果 Folder 位於使用者有權存取的共用雲端硬碟中。

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

參數

名稱類型說明
userUser要移除的使用者表示法。

回攻員

Folder：這個 Folder 用於鏈結。

授權

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

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

revokePermissions(emailAddress)

撤銷已授予特定使用者的 Folder 存取權。這個方法 如果使用者所屬的課程有以下使用者類別，則禁止使用者存取 Folder 但具備一般存取權，例如將 Folder 與使用者的 整個網域。

參數

名稱類型說明
emailAddressString應撤銷存取權的使用者電子郵件地址。

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

revokePermissions(user)

撤銷已授予特定使用者的 Folder 存取權。這個方法 如果使用者所屬的課程有以下使用者類別，則禁止使用者存取 Folder 但具備一般存取權，例如將 Folder 與使用者的 整個網域。

參數

名稱類型說明
userUser代表應撤銷其存取權的使用者。

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

searchFiles(params)

取得目前資料夾內符合指定搜尋條件的所有檔案的集合 標準。如要進一步瞭解搜尋條件，請參閱 Google 雲端硬碟 SDK 說明文件。請注意，雲端硬碟 服務使用的 Drive API v2，部分查詢欄位與第 3 版不同。查看欄位 第 2 版和第 3 版的差異。

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 - 目前資料夾子項與搜尋條件相符的所有檔案的集合 標準。

授權

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

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

searchFolders(params)

取得目前資料夾的子項資料夾集合，且這些資料夾符合指定的搜尋條件 標準。如要進一步瞭解搜尋條件，請參閱 Google 雲端硬碟 SDK 說明文件。請注意，雲端硬碟 服務使用的 Drive API v2，部分查詢欄位與第 3 版不同。查看欄位 第 2 版和第 3 版的差異。

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 - 目前資料夾子項與搜尋條件相符的所有資料夾集合 標準。

授權

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

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

setDescription(description)

設定 Folder 的說明。

參數

名稱類型說明
descriptionString「Folder」的新說明

回攻員

Folder：這個 Folder，用於鏈結

授權

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

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

setName(name)

設定 Folder 的名稱。

參數

名稱類型說明
nameStringFolder 的新名稱

回攻員

Folder：這個 Folder，用於鏈結

授權

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

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

setOwner(emailAddress)

變更 Folder 的擁有者。這麼做也會讓先前的擁有者 明確授予Folder的編輯權限。

參數

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

回攻員

Folder：這個 Folder，用於鏈結

授權

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

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

setOwner(user)

變更 Folder 的擁有者。這麼做也會讓先前的擁有者 明確授予Folder的編輯權限。

參數

名稱類型說明
userUser應成為新擁有者的使用者

回攻員

Folder：這個 Folder，用於鏈結

授權

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

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

setSecurityUpdateEnabled(enabled)

設定 Folder 在什麼情況下是否需要資源金鑰才能存取 透過連結分享。系統預設會啟用符合資格的檔案和資料夾。

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

參數

名稱類型說明
enabledBoolean是否啟用 Folder 的資源金鑰規定。

回攻員

Folder - 這個 Folder 用於鏈結。

授權

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

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

setShareableByEditors(shareable)

設定是否允許擁有Folder編輯權限的使用者可以共用檔案 與其他使用者共用或變更權限新的 Folder 預設為 true。

參數

名稱類型說明
shareableBooleantrue：如果具備編輯權限的使用者可以共用對象 或變更權限；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.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

參數

名稱類型說明
accessTypeAccess哪些使用者類別應能存取 Folder
permissionTypePermission應授予哪些使用者有權存取 Folder 的權限

回攻員

Folder：這個 Folder，用於鏈結

授權

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

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

setStarred(starred)

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

參數

名稱類型說明
starredBoolean如果 Folder 應在使用者的應用程式中加上星號，則為 true 雲端硬碟如果不需要，則設為false

回攻員

Folder：這個 Folder，用於鏈結

授權

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

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

setTrashed(trashed)

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

參數

名稱類型說明
trashedBooleantrue表示應將Folder移至垃圾桶 使用者的雲端硬碟；如果不需要，則設為false

回攻員

Folder：這個 Folder，用於鏈結

授權

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

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

已淘汰的方法