Drive Service

Drive

Dịch vụ này cho phép các tập lệnh tạo, tìm và sửa đổi tệp cũng như thư mục trong Google Drive.

Nếu tập lệnh của bạn sử dụng dự án Google Cloud chuẩn thay vì dự án Google Cloud mặc định, thì bạn phải bật API Drive theo cách thủ công. Trong dự án Google Cloud tiêu chuẩn, hãy bật API Drive:

Bật API Drive

Mã mẫu sau đây cho biết cách ghi nhật ký tên của từng tệp trong thư mục Drive của tôi của người dùng:

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

Lưu ý: Quản trị viên Google Workspace có thể tắt SDK Drive cho miền của họ. Thao tác này sẽ ngăn người dùng cài đặt và dùng các ứng dụng Google Drive. Chế độ cài đặt này cũng ngăn người dùng sử dụng tập lệnh Apps Script, ứng dụng web và tiện ích bổ sung sử dụng dịch vụ Drive hoặc Dịch vụ Drive nâng cao (ngay cả khi tiện ích bổ sung hoặc ứng dụng web đã được cài đặt trước khi quản trị viên tắt SDK Drive).

Tuy nhiên, nếu một tiện ích bổ sung sử dụng dịch vụ Drive được phát hành để cài đặt trên toàn miền và được quản trị viên cài đặt cho một số hoặc tất cả người dùng trong miền hoặc bất kỳ tập lệnh nào có ứng dụng OAuth được quản trị viên miền cho phép, thì các chức năng tiện ích bổ sung đó cho những người dùng đó ngay cả khi SDK Drive bị tắt trong miền.

Lớp

Tên	Mô tả ngắn
Access	Một enum biểu thị các lớp người dùng có thể truy cập vào tệp hoặc thư mục, bên cạnh bất kỳ người dùng cá nhân nào đã được cấp quyền truy cập một cách rõ ràng.
DriveApp	Cho phép tập lệnh tạo, tìm và sửa đổi tệp cũng như thư mục trong Google Drive.
File	Một tệp trong Google Drive.
FileIterator	Một trình lặp cho phép các tập lệnh lặp lại trên một tập hợp tệp có thể lớn.
Folder	Một thư mục trong Google Drive.
FolderIterator	Một đối tượng cho phép các tập lệnh lặp lại trên một tập hợp thư mục có thể lớn.
Permission	Một enum biểu thị các quyền đã cấp cho những người dùng có thể truy cập vào tệp hoặc thư mục, bên cạnh mọi người dùng cá nhân đã được cấp quyền truy cập một cách rõ ràng.
User	Người dùng liên kết với một tệp trong Google Drive.

Access

Thuộc tính

Tài sản	Loại	Nội dung mô tả
ANYONE	Enum	Bất kỳ ai có kết nối Internet đều có thể tìm và truy cập.
ANYONE_WITH_LINK	Enum	Bất kỳ ai có đường liên kết đều có thể truy cập.
DOMAIN	Enum	Mọi người trong miền của bạn đều có thể tìm và truy cập.
DOMAIN_WITH_LINK	Enum	Những người trong miền của bạn có đường liên kết đều có thể truy cập.
PRIVATE	Enum	Chỉ những người được cấp quyền rõ ràng mới có thể truy cập.

DriveApp

Thuộc tính

Tài sản	Loại	Nội dung mô tả
Access	Access	Một enum biểu thị các lớp người dùng có thể truy cập vào tệp hoặc thư mục, bên cạnh bất kỳ người dùng cá nhân nào đã được cấp quyền truy cập một cách rõ ràng.
Permission	Permission	Một enum biểu thị các quyền đã cấp cho những người dùng có thể truy cập vào tệp hoặc thư mục, bên cạnh mọi người dùng cá nhân đã được cấp quyền truy cập một cách rõ ràng.

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
continueFileIterator(continuationToken)	FileIterator	Tiếp tục vòng lặp tệp bằng mã thông báo tiếp tục từ một trình lặp trước đó.
continueFolderIterator(continuationToken)	FolderIterator	Tiếp tục vòng lặp thư mục bằng mã thông báo tiếp tục từ một trình lặp trước đó.
createFile(blob)	File	Tạo một tệp trong thư mục gốc của Drive của người dùng từ một Blob dữ liệu tuỳ ý nhất định.
createFile(name, content)	File	Tạo một tệp văn bản có tên và nội dung đã đặt trong thư mục gốc của Drive của người dùng.
createFile(name, content, mimeType)	File	Tạo một tệp trong thư mục gốc trên Drive của người dùng với tên, nội dung và loại MIME đã cho.
createFolder(name)	Folder	Tạo thư mục trong thư mục gốc trong Drive của người dùng theo tên đã đặt.
createShortcut(targetId)	File	Tạo một lối tắt đến mã mục Drive được cung cấp rồi trả về mã đó.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)	File	Tạo một lối tắt đến mã mục Drive và khoá tài nguyên được cung cấp rồi trả về mã đó.
enforceSingleParent(value)	void	Bật hoặc tắt hành vi performSingleParent cho tất cả các lệnh gọi ảnh hưởng đến phần tử mẹ của mục.
getFileById(id)	File	Lấy tệp có mã nhận dạng đã cho.
getFileByIdAndResourceKey(id, resourceKey)	File	Lấy tệp có mã nhận dạng và khoá tài nguyên đã cho.
getFiles()	FileIterator	Lấy một tập hợp tất cả các tệp trong Drive của người dùng.
getFilesByName(name)	FileIterator	Lấy tập hợp tất cả các tệp có tên cụ thể trong Drive của người dùng.
getFilesByType(mimeType)	FileIterator	Lấy tập hợp tất cả các tệp trong Drive của người dùng có loại MIME đã cho.
getFolderById(id)	Folder	Lấy thư mục có mã nhận dạng đã cho.
getFolderByIdAndResourceKey(id, resourceKey)	Folder	Lấy thư mục có mã nhận dạng và khoá tài nguyên đã cho.
getFolders()	FolderIterator	Lấy một tập hợp tất cả các thư mục trong Drive của người dùng.
getFoldersByName(name)	FolderIterator	Lấy tập hợp tất cả các thư mục có tên cụ thể trong Drive của người dùng.
getRootFolder()	Folder	Lấy thư mục ở thư mục gốc trong Drive của người dùng.
getStorageLimit()	Integer	Lấy số byte mà người dùng được phép lưu trữ trong Drive.
getStorageUsed()	Integer	Lấy số byte mà người dùng hiện đang lưu trữ trong Drive.
getTrashedFiles()	FileIterator	Tải tập hợp tất cả các tệp trong thùng rác trên Drive của người dùng.
getTrashedFolders()	FolderIterator	Tải tập hợp tất cả thư mục trong thùng rác trên Drive của người dùng.
searchFiles(params)	FileIterator	Lấy tập hợp tất cả các tệp trong Drive của người dùng khớp với các tiêu chí tìm kiếm nhất định.
searchFolders(params)	FolderIterator	Lấy tập hợp tất cả các thư mục trong Drive của người dùng khớp với các tiêu chí tìm kiếm nhất định.

File

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
addCommenter(emailAddress)	File	Thêm người dùng cụ thể vào danh sách người nhận xét cho File.
addCommenter(user)	File	Thêm người dùng cụ thể vào danh sách người nhận xét cho File.
addCommenters(emailAddresses)	File	Thêm mảng người dùng đã cho vào danh sách người nhận xét cho File.
addEditor(emailAddress)	File	Thêm người dùng đã cho vào danh sách người chỉnh sửa của File.
addEditor(user)	File	Thêm người dùng đã cho vào danh sách người chỉnh sửa của File.
addEditors(emailAddresses)	File	Thêm mảng người dùng đã cho vào danh sách trình chỉnh sửa của File.
addViewer(emailAddress)	File	Thêm người dùng cụ thể vào danh sách người xem của File.
addViewer(user)	File	Thêm người dùng cụ thể vào danh sách người xem của File.
addViewers(emailAddresses)	File	Thêm mảng người dùng đã cho vào danh sách người xem của File.
getAccess(email)	Permission	Nhận quyền được cấp cho người dùng cụ thể.
getAccess(user)	Permission	Nhận quyền được cấp cho người dùng cụ thể.
getAs(contentType)	Blob	Trả về dữ liệu bên trong đối tượng này dưới dạng một blob được chuyển đổi thành loại nội dung được chỉ định.
getBlob()	Blob	Trả về dữ liệu bên trong đối tượng này dưới dạng một blob.
getDateCreated()	Date	Lấy ngày tạo File.
getDescription()	String	Lấy nội dung mô tả cho File.
getDownloadUrl()	String	Lấy URL có thể dùng để tải tệp xuống.
getEditors()	User[]	Lấy danh sách người chỉnh sửa cho File này.
getId()	String	Lấy mã nhận dạng của File.
getLastUpdated()	Date	Lấy ngày cập nhật File gần đây nhất.
getMimeType()	String	Lấy loại MIME của tệp.
getName()	String	Lấy tên của File.
getOwner()	User	Lấy chủ sở hữu tệp.
getParents()	FolderIterator	Lấy một tập hợp các thư mục là thành phần mẹ trực tiếp của File.
getResourceKey()	String	Lấy khoá tài nguyên của File cần thiết để truy cập vào các mục đã được chia sẻ bằng một đường liên kết.
getSecurityUpdateEligible()	Boolean	Kiểm tra xem File này có đủ điều kiện áp dụng bản cập nhật bảo mật yêu cầu khoá tài nguyên để truy cập khi được chia sẻ bằng một đường liên kết hay không.
getSecurityUpdateEnabled()	Boolean	Biết được File này có yêu cầu khoá tài nguyên để truy cập hay không khi được chia sẻ bằng một đường liên kết.
getSharingAccess()	Access	Lấy thông tin về lớp người dùng có thể truy cập vào File, ngoài từng người dùng riêng lẻ đã được cấp quyền truy cập một cách rõ ràng.
getSharingPermission()	Permission	Nhận quyền được cấp cho những người dùng có thể truy cập vào File, ngoài người dùng cá nhân đã được cấp quyền truy cập một cách rõ ràng.
getSize()	Integer	Lấy số byte dùng để lưu trữ File trong Drive.
getTargetId()	String	Nếu đây là một Phím tắt, hãy trả về mã nhận dạng của mục mà phím tắt đó trỏ đến.
getTargetMimeType()	String	Nếu đây là phím tắt, hãy trả về loại MIME của mục mà mã trỏ đến.
getTargetResourceKey()	String	Nếu tệp là một lối tắt, hàm sẽ trả về khoá tài nguyên của mục mà tệp trỏ tới.
getThumbnail()	Blob	Lấy hình thu nhỏ cho tệp hoặc null nếu không có hình thu nhỏ nào.
getUrl()	String	Lấy URL có thể dùng để mở File trong một ứng dụng Google như Drive hoặc Tài liệu.
getViewers()	User[]	Xem danh sách người xem và người nhận xét cho File này.
isShareableByEditors()	Boolean	Xác định xem người dùng có quyền chỉnh sửa đối với File có được phép chia sẻ với người dùng khác hoặc thay đổi quyền hay không.
isStarred()	Boolean	Xác định xem File đã được gắn dấu sao trong Drive của người dùng hay chưa.
isTrashed()	Boolean	Xác định xem File có trong thùng rác trong Drive của người dùng hay không.
makeCopy()	File	Tạo bản sao của tệp.
makeCopy(destination)	File	Tạo bản sao của tệp trong thư mục đích.
makeCopy(name)	File	Tạo một bản sao của tệp rồi đặt tên cho tệp đó bằng tên đã cho.
makeCopy(name, destination)	File	Tạo một bản sao của tệp trong thư mục đích và đặt tên cho tệp đó bằng tên đã cho.
moveTo(destination)	File	Di chuyển mục này sang thư mục đích đã cung cấp.
removeCommenter(emailAddress)	File	Xoá người dùng đã chọn khỏi danh sách người nhận xét của File.
removeCommenter(user)	File	Xoá người dùng đã chọn khỏi danh sách người nhận xét của File.
removeEditor(emailAddress)	File	Xoá người dùng cụ thể khỏi danh sách người chỉnh sửa của File.
removeEditor(user)	File	Xoá người dùng cụ thể khỏi danh sách người chỉnh sửa của File.
removeViewer(emailAddress)	File	Xoá người dùng cụ thể khỏi danh sách người xem và người nhận xét của File.
removeViewer(user)	File	Xoá người dùng cụ thể khỏi danh sách người xem và người nhận xét của File.
revokePermissions(emailAddress)	File	Thu hồi quyền truy cập File đã cấp cho người dùng đã cấp.
revokePermissions(user)	File	Thu hồi quyền truy cập File đã cấp cho người dùng đã cấp.
setContent(content)	File	Ghi đè nội dung của tệp bằng một thay thế cho trước.
setDescription(description)	File	Đặt nội dung mô tả cho File.
setName(name)	File	Đặt tên cho File.
setOwner(emailAddress)	File	Thay đổi chủ sở hữu của File.
setOwner(user)	File	Thay đổi chủ sở hữu của File.
setSecurityUpdateEnabled(enabled)	File	Thiết lập xem File có yêu cầu khoá tài nguyên để truy cập hay không khi được chia sẻ bằng một đường liên kết.
setShareableByEditors(shareable)	File	Thiết lập xem người dùng có quyền chỉnh sửa đối với File có được phép chia sẻ với người dùng khác hoặc thay đổi quyền hay không.
setSharing(accessType, permissionType)	File	Đặt lớp người dùng có thể truy cập vào File và những quyền mà người dùng đó được cấp, ngoài bất kỳ người dùng cá nhân nào đã được cấp quyền truy cập rõ ràng.
setStarred(starred)	File	Thiết lập xem File có được gắn dấu sao trong Drive của người dùng hay không.
setTrashed(trashed)	File	Thiết lập liệu File có trong thùng rác trong Drive của người dùng hay không.

FileIterator

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
getContinuationToken()	String	Lấy một mã thông báo có thể dùng để tiếp tục vòng lặp này sau này.
hasNext()	Boolean	Xác định xem việc gọi next() có trả về một mục hay không.
next()	File	Lấy mục tiếp theo trong tập hợp tệp hoặc thư mục.

Folder

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
addEditor(emailAddress)	Folder	Thêm người dùng đã cho vào danh sách người chỉnh sửa của Folder.
addEditor(user)	Folder	Thêm người dùng đã cho vào danh sách người chỉnh sửa của Folder.
addEditors(emailAddresses)	Folder	Thêm mảng người dùng đã cho vào danh sách trình chỉnh sửa của Folder.
addViewer(emailAddress)	Folder	Thêm người dùng cụ thể vào danh sách người xem của Folder.
addViewer(user)	Folder	Thêm người dùng cụ thể vào danh sách người xem của Folder.
addViewers(emailAddresses)	Folder	Thêm mảng người dùng đã cho vào danh sách người xem của Folder.
createFile(blob)	File	Tạo một tệp trong thư mục hiện tại từ Blob dữ liệu tuỳ ý nhất định.
createFile(name, content)	File	Tạo một tệp văn bản trong thư mục hiện tại có tên và nội dung đã cho.
createFile(name, content, mimeType)	File	Tạo một tệp trong thư mục hiện tại có tên, nội dung và loại MIME đã cho.
createFolder(name)	Folder	Tạo một thư mục trong thư mục hiện tại bằng tên đã cho.
createShortcut(targetId)	File	Tạo một lối tắt đến mã mục Drive được cung cấp rồi trả về mã đó.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)	File	Tạo một lối tắt đến mã mục Drive và khoá tài nguyên được cung cấp rồi trả về mã đó.
getAccess(email)	Permission	Nhận quyền được cấp cho người dùng cụ thể.
getAccess(user)	Permission	Nhận quyền được cấp cho người dùng cụ thể.
getDateCreated()	Date	Lấy ngày tạo Folder.
getDescription()	String	Lấy nội dung mô tả cho Folder.
getEditors()	User[]	Lấy danh sách người chỉnh sửa cho Folder này.
getFiles()	FileIterator	Lấy một tập hợp gồm tất cả các tệp là tệp con của thư mục hiện tại.
getFilesByName(name)	FileIterator	Lấy một tập hợp gồm tất cả các tệp là tệp con của thư mục hiện tại và có tên cụ thể.
getFilesByType(mimeType)	FileIterator	Lấy một tập hợp tất cả các tệp là tệp con của thư mục hiện tại và có loại MIME đã cho.
getFolders()	FolderIterator	Lấy một tập hợp tất cả các thư mục là thư mục con của thư mục hiện tại.
getFoldersByName(name)	FolderIterator	Lấy một tập hợp tất cả các thư mục là thư mục con của thư mục hiện tại và có tên cụ thể.
getId()	String	Lấy mã nhận dạng của Folder.
getLastUpdated()	Date	Lấy ngày cập nhật Folder gần đây nhất.
getName()	String	Lấy tên của Folder.
getOwner()	User	Tìm chủ sở hữu của Folder này.
getParents()	FolderIterator	Lấy một tập hợp các thư mục là thành phần mẹ trực tiếp của Folder.
getResourceKey()	String	Lấy khoá tài nguyên của Folder cần thiết để truy cập vào các mục đã được chia sẻ bằng một đường liên kết.
getSecurityUpdateEligible()	Boolean	Kiểm tra xem Folder này có đủ điều kiện áp dụng bản cập nhật bảo mật yêu cầu khoá tài nguyên để truy cập khi được chia sẻ bằng một đường liên kết hay không.
getSecurityUpdateEnabled()	Boolean	Biết được Folder này có yêu cầu khoá tài nguyên để truy cập hay không khi được chia sẻ bằng một đường liên kết.
getSharingAccess()	Access	Lấy thông tin về lớp người dùng có thể truy cập vào Folder, ngoài từng người dùng riêng lẻ đã được cấp quyền truy cập một cách rõ ràng.
getSharingPermission()	Permission	Nhận quyền được cấp cho những người dùng có thể truy cập vào Folder, ngoài người dùng cá nhân đã được cấp quyền truy cập một cách rõ ràng.
getSize()	Integer	Lấy số byte dùng để lưu trữ Folder trong Drive.
getUrl()	String	Lấy URL có thể dùng để mở Folder trong một ứng dụng Google như Drive hoặc Tài liệu.
getViewers()	User[]	Xem danh sách người xem và người nhận xét cho Folder này.
isShareableByEditors()	Boolean	Xác định xem người dùng có quyền chỉnh sửa đối với Folder có được phép chia sẻ với người dùng khác hoặc thay đổi quyền hay không.
isStarred()	Boolean	Xác định xem Folder đã được gắn dấu sao trong Drive của người dùng hay chưa.
isTrashed()	Boolean	Xác định xem Folder có trong thùng rác trong Drive của người dùng hay không.
moveTo(destination)	Folder	Di chuyển mục này sang thư mục đích đã cung cấp.
removeEditor(emailAddress)	Folder	Xoá người dùng cụ thể khỏi danh sách người chỉnh sửa của Folder.
removeEditor(user)	Folder	Xoá người dùng cụ thể khỏi danh sách người chỉnh sửa của Folder.
removeViewer(emailAddress)	Folder	Xoá người dùng cụ thể khỏi danh sách người xem và người nhận xét của Folder.
removeViewer(user)	Folder	Xoá người dùng cụ thể khỏi danh sách người xem và người nhận xét của Folder.
revokePermissions(emailAddress)	Folder	Thu hồi quyền truy cập Folder đã cấp cho người dùng đã cấp.
revokePermissions(user)	Folder	Thu hồi quyền truy cập Folder đã cấp cho người dùng đã cấp.
searchFiles(params)	FileIterator	Lấy một tập hợp gồm tất cả các tệp là tệp con của thư mục hiện tại và khớp với các tiêu chí tìm kiếm nhất định.
searchFolders(params)	FolderIterator	Lấy một tập hợp tất cả các thư mục là thư mục con của thư mục hiện tại và khớp với các tiêu chí tìm kiếm nhất định.
setDescription(description)	Folder	Đặt nội dung mô tả cho Folder.
setName(name)	Folder	Đặt tên cho Folder.
setOwner(emailAddress)	Folder	Thay đổi chủ sở hữu của Folder.
setOwner(user)	Folder	Thay đổi chủ sở hữu của Folder.
setSecurityUpdateEnabled(enabled)	Folder	Thiết lập xem Folder có yêu cầu khoá tài nguyên để truy cập hay không khi được chia sẻ bằng một đường liên kết.
setShareableByEditors(shareable)	Folder	Thiết lập xem người dùng có quyền chỉnh sửa đối với Folder có được phép chia sẻ với người dùng khác hoặc thay đổi quyền hay không.
setSharing(accessType, permissionType)	Folder	Đặt lớp người dùng có thể truy cập vào Folder và những quyền mà người dùng đó được cấp, ngoài bất kỳ người dùng cá nhân nào đã được cấp quyền truy cập rõ ràng.
setStarred(starred)	Folder	Thiết lập xem Folder có được gắn dấu sao trong Drive của người dùng hay không.
setTrashed(trashed)	Folder	Thiết lập liệu Folder có trong thùng rác trong Drive của người dùng hay không.

FolderIterator

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
getContinuationToken()	String	Lấy một mã thông báo có thể dùng để tiếp tục vòng lặp này sau này.
hasNext()	Boolean	Xác định xem việc gọi next() có trả về một mục hay không.
next()	Folder	Lấy mục tiếp theo trong tập hợp tệp hoặc thư mục.

Permission

Thuộc tính

Tài sản	Loại	Nội dung mô tả
VIEW	Enum	Những người dùng có quyền truy cập vào tệp hoặc thư mục chỉ có thể xem hoặc sao chép tệp hoặc thư mục đó.
EDIT	Enum	Những người dùng có thể truy cập vào tệp hoặc thư mục cũng có thể chỉnh sửa tệp hoặc thư mục.
COMMENT	Enum	Những người dùng có quyền truy cập vào tệp hoặc thư mục chỉ có thể xem, sao chép hoặc nhận xét về tệp hoặc thư mục đó.
OWNER	Enum	Người dùng sở hữu tệp hoặc thư mục.
ORGANIZER	Enum	Những người dùng có thể sắp xếp tệp và thư mục trong bộ nhớ dùng chung.
FILE_ORGANIZER	Enum	Những người dùng có thể chỉnh sửa, chuyển vào thùng rác và di chuyển nội dung trong bộ nhớ dùng chung.
NONE	Enum	Người dùng không có quyền nào đối với tệp hoặc thư mục.

User

Phương thức

Phương thức	Kiểu dữ liệu trả về	Mô tả ngắn
getDomain()	String	Lấy tên miền liên kết với tài khoản của người dùng.
getEmail()	String	Lấy địa chỉ email của người dùng.
getName()	String	Lấy tên của người dùng.
getPhotoUrl()	String	Lấy URL ảnh của người dùng.