Drive Service

透過集合功能整理內容 你可以依據偏好儲存及分類內容。
雲端硬碟

這項服務可讓指令碼在 Google 雲端硬碟中建立、尋找及修改檔案和資料夾。

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

類別

名稱簡短說明
Access這個列舉代表可存取檔案或資料夾的使用者類別,適用於明確獲得存取權的個別使用者。
DriveApp允許指令碼在 Google 雲端硬碟中建立、尋找及修改檔案和資料夾。
FileGoogle 雲端硬碟中的檔案。
FileIterator可讓指令碼疊代大量檔案集合的疊代器。
FolderGoogle 雲端硬碟中的資料夾。
FolderIterator這個物件可讓指令碼疊代大量大量資料夾。
Permission列舉是指可存取檔案或資料夾的使用者的列舉,除了已明確授予存取權的使用者之外。
User與 Google 雲端硬碟檔案相關聯的使用者。

Access

屬性

屬性類型說明
ANYONEEnum網際網路上的所有使用者皆可尋找和存取。
ANYONE_WITH_LINKEnum知道連結的使用者皆可存取。
DOMAINEnum您網域中的使用者可以尋找及存取。
DOMAIN_WITH_LINKEnum您網域中知道連結的使用者皆可存取。
PRIVATEEnum僅獲得明確授權的使用者可以存取。

DriveApp

屬性

屬性類型說明
AccessAccess這個列舉代表可存取檔案或資料夾的使用者類別,適用於明確獲得存取權的個別使用者。
PermissionPermission列舉是指可存取檔案或資料夾的使用者的列舉,除了已明確授予存取權的使用者之外。

方法

方法傳回類型簡短說明
continueFileIterator(continuationToken)FileIterator使用先前疊代器的接續權杖繼續檔案疊代。
continueFolderIterator(continuationToken)FolderIterator使用上一個疊代器的接續權杖重新啟用資料夾疊代。
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 和資源金鑰捷徑,然後加以傳回。
enforceSingleParent(value)void針對影響項目上層的所有呼叫啟用或停用強制執行 SingleSingle 行為。
getFileById(id)File取得具有指定 ID 的檔案。
getFileByIdAndResourceKey(id, resourceKey)File取得具有指定 ID 和資源金鑰的檔案。
getFiles()FileIterator取得使用者雲端硬碟中的所有檔案集合。
getFilesByName(name)FileIterator取得使用者雲端硬碟中具備指定名稱的所有檔案。
getFilesByType(mimeType)FileIterator取得使用者雲端硬碟中具備指定 MIME 類型的所有檔案。
getFolderById(id)Folder取得具有指定 ID 的資料夾。
getFolderByIdAndResourceKey(id, resourceKey)Folder取得具有指定 ID 和資源金鑰的資料夾。
getFolders()FolderIterator取得使用者雲端硬碟中所有資料夾的集合。
getFoldersByName(name)FolderIterator取得使用者雲端硬碟中具備指定名稱的所有資料夾。
getRootFolder()Folder取得使用者雲端硬碟根目錄下的資料夾。
getStorageLimit()Integer取得使用者儲存在雲端硬碟的位元組數。
getStorageUsed()Integer取得使用者目前在雲端硬碟中儲存的位元組數。
getTrashedFiles()FileIterator取得使用者雲端硬碟垃圾桶內所有檔案的集合。
getTrashedFolders()FolderIterator取得使用者雲端硬碟垃圾桶中所有資料夾的集合。
searchFiles(params)FileIterator取得使用者雲端硬碟中符合指定搜尋條件的所有檔案集合。
searchFolders(params)FolderIterator取得使用者雲端硬碟中符合指定搜尋條件的所有資料夾集合。

File

方法

方法傳回類型簡短說明
addCommenter(emailAddress)File將指定使用者新增至 File 的留言者清單中。
addCommenter(user)File將指定使用者新增至 File 的留言者清單中。
addCommenters(emailAddresses)File將指定的使用者陣列新增至 File 的加註者清單中。
addEditor(emailAddress)File將指定使用者新增至 File 的編輯者清單。
addEditor(user)File將指定使用者新增至 File 的編輯者清單。
addEditors(emailAddresses)File將指定使用者陣列新增至 File 的編輯者清單。
addViewer(emailAddress)File將指定使用者新增至 File 的檢視者清單中。
addViewer(user)File將指定使用者新增至 File 的檢視者清單中。
addViewers(emailAddresses)File將指定使用者陣列新增至 File 的檢視者清單。
getAccess(email)Permission將權限授予指定使用者。
getAccess(user)Permission將權限授予指定使用者。
getAs(contentType)Blob傳回此物件中的資料,以轉換為指定內容類型的 blob。
getBlob()Blob傳回這個物件中的資料,以 blob 形式傳回。
getDateCreated()Date取得 File 的建立日期。
getDescription()String取得 File 的說明。
getDownloadUrl()String取得可用來下載檔案的網址。
getEditors()User[]取得這個File的編輯者清單。
getId()String取得 File 的 ID。
getLastUpdated()Date取得 File 上次更新時間。
getMimeType()String取得檔案的 MIME 類型。
getName()String取得 File 的名稱。
getOwner()User取得 File 的擁有者。
getParents()FolderIterator取得立即成為 File 父項的資料夾集合。
getResourceKey()String取得 File 的資源金鑰,以便存取透過連結共用的項目。
getSecurityUpdateEligible()Boolean取得這個 File 是否符合套用連結時,需要使用資源金鑰存取的安全性更新的資格。
getSecurityUpdateEnabled()Boolean取得這個 File 是否要求使用連結共用資源時,必須有資源金鑰才能存取。
getSharingAccess()Access除了明確獲得存取權的任何個別使用者之外,取得哪個類別的使用者可以存取 File
getSharingPermission()Permission將存取權授予具有存取 File 權限的使用者,除了已明確授予存取權的個別使用者以外。
getSize()Integer取得用於將 File 儲存在雲端硬碟中的位元組數。
getTargetId()String如果這是捷徑,則會傳回其指向項目的 ID。
getTargetMimeType()String如果這是捷徑,則會傳回其所代表項目的 MIME 類型。
getTargetResourceKey()String如果檔案是捷徑,則會傳回其指向項目的資源金鑰。
getThumbnail()Blob取得檔案的縮圖;如果沒有縮圖,則為 null
getUrl()String取得可用於在 Google 應用程式 (例如雲端硬碟或文件) 中開啟 File 的網址。
getViewers()User[]取得這個File的檢視者和加註者清單。
isShareableByEditors()Boolean決定是否允許使用者取得 File 的編輯權限,才能與其他使用者共用或變更權限。
isStarred()Boolean判斷File是否在使用者雲端硬碟中加上星號。
isTrashed()Boolean判斷 File 是否位於使用者雲端硬碟的垃圾桶。
makeCopy()File建立檔案的副本。
makeCopy(destination)File在目的地目錄中建立檔案副本。
makeCopy(name)File建立檔案副本,並根據提供的名稱命名。
makeCopy(name, destination)File在目的地目錄中建立檔案副本,並使用你提供的名稱命名。
moveTo(destination)File將這個項目移至所提供的目的地資料夾。
removeCommenter(emailAddress)FileFile 的留言者清單中移除指定使用者。
removeCommenter(user)FileFile 的留言者清單中移除指定使用者。
removeEditor(emailAddress)FileFile 的編輯者清單中移除指定使用者。
removeEditor(user)FileFile 的編輯者清單中移除指定使用者。
removeViewer(emailAddress)FileFile 的檢視者和加註者清單中移除指定使用者。
removeViewer(user)FileFile 的檢視者和加註者清單中移除指定使用者。
revokePermissions(user)File撤銷已授予指定使用者的 File 存取權。
revokePermissions(user)File撤銷已授予指定使用者的 File 存取權。
setContent(content)File以指定的替代項目覆寫檔案內容。
setDescription(description)File設定 File 的說明。
setName(name)File設定 File 的名稱。
setOwner(emailAddress)File變更 File 的擁有者。
setOwner(user)File變更 File 的擁有者。
setSecurityUpdateEnabled(enabled)File設定 File 是否要求使用連結共用資源時,必須有資源金鑰才能存取。
setShareableByEditors(shareable)File設定是否允許具有 File 編輯權限的使用者與其他使用者共用或變更權限。
setSharing(accessType, permissionType)File設定哪類使用者可以存取 File,以及授予這些使用者哪些權限 (除了明確獲得存取權的個別使用者之外)。
setStarred(starred)File設定是否要在使用者的雲端硬碟中標示 File
setTrashed(trashed)File設定 File 是否位於使用者的雲端硬碟垃圾桶。

FileIterator

方法

方法傳回類型簡短說明
getContinuationToken()String取得可用於日後再次疊代的權杖。
hasNext()Boolean決定呼叫 next() 是否會傳回項目。
next()File取得檔案或資料夾集合中的下一個項目。

Folder

方法

方法傳回類型簡短說明
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 的網址。
getViewers()User[]取得這個Folder的檢視者和加註者清單。
isShareableByEditors()Boolean決定是否允許使用者取得 Folder 的編輯權限,才能與其他使用者共用或變更權限。
isStarred()Boolean判斷Folder是否在使用者雲端硬碟中加上星號。
isTrashed()Boolean判斷 Folder 是否位於使用者雲端硬碟的垃圾桶。
moveTo(destination)Folder將這個項目移至所提供的目的地資料夾。
removeEditor(emailAddress)FolderFolder 的編輯者清單中移除指定使用者。
removeEditor(user)FolderFolder 的編輯者清單中移除指定使用者。
removeViewer(emailAddress)FolderFolder 的檢視者和加註者清單中移除指定使用者。
removeViewer(user)FolderFolder 的檢視者和加註者清單中移除指定使用者。
revokePermissions(user)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 是否位於使用者的雲端硬碟垃圾桶。

FolderIterator

方法

方法傳回類型簡短說明
getContinuationToken()String取得可用於日後再次疊代的權杖。
hasNext()Boolean決定呼叫 next() 是否會傳回項目。
next()Folder取得檔案或資料夾集合中的下一個項目。

Permission

屬性

屬性類型說明
VIEWEnum可存取檔案或資料夾的使用者只能檢視或複製內容。
EDITEnum有權存取該檔案或資料夾的使用者都能進行編輯。
COMMENTEnum可存取檔案或資料夾的使用者只能查看、複製檔案或資料夾,或在檔案中加上註解。
OWNEREnum使用者擁有檔案或資料夾。
ORGANIZEREnum可在共用雲端硬碟中整理檔案和資料夾的使用者。
FILE_ORGANIZEREnum可在共用雲端硬碟中編輯、移至垃圾桶及移動內容的使用者。
NONEEnum使用者沒有檔案或資料夾的任何權限。

User

方法

方法傳回類型簡短說明
getDomain()String取得與使用者帳戶相關聯的網域名稱。
getEmail()String取得使用者的電子郵件地址。
getName()String取得使用者的名稱。
getPhotoUrl()String取得使用者相片的網址。