Drive Service

Drive

Dịch vụ này cho phép tập lệnh tạo, tìm và sửa đổi các tệp và thư mục trong Google Drive. Mặc dù dễ sử dụng hơn, nhưng dịch vụ Drive tích hợp có một số hạn chế. Để sử dụng các tính năng và dịch vụ hỗ trợ mới nhất, cũng như truy cập vào tệp hoặc thư mục trong bộ nhớ dùng chung, hãy sử dụng dịch vụ Drive nâng cao.

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

Bật Drive API

Đoạn 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ớp

TênMô tả ngắn
AccessMột enum đại diện cho các lớp người dùng có thể truy cập vào một tệp hoặc thư mục, ngoài bất kỳ người dùng riêng lẻ nào đã được cấp quyền truy cập một cách rõ ràng.
DriveAppCho phép tập lệnh tạo, tìm và sửa đổi các tệp và thư mục trong Google Drive.
FileMột tệp trong Google Drive.
FileIteratorMột đối tượng lặp cho phép tập lệnh lặp lại trên một tập hợp tệp có thể có kích thước lớn.
FolderMột thư mục trong Google Drive.
FolderIteratorMột đối tượng cho phép tập lệnh lặp lại trên một tập hợp thư mục có thể lớn.
PermissionMột enum đại diện cho các quyền được cấp cho người dùng có thể truy cập vào một tệp hoặc thư mục, ngoài bất kỳ người dùng riêng lẻ nào đã được cấp quyền truy cập một cách rõ ràng.
UserMột người dùng được liên kết với một tệp trong Google Drive.

Access

Thuộc tính

Thuộc tínhLoạiMô tả
ANYONEEnumBất kỳ ai có kết nối Internet đều có thể tìm thấy và truy cập.
ANYONE_WITH_LINKEnumBất kỳ ai có liên kết đều có thể truy cập.
DOMAINEnumMọi người trong miền của bạn có thể tìm thấy và truy cập.
DOMAIN_WITH_LINKEnumNhững người trong miền của bạn có đường liên kết đều có thể truy cập.
PRIVATEEnumChỉ những người được cấp quyền rõ ràng mới có thể truy cập.

DriveApp

Thuộc tính

Thuộc tínhLoạiMô tả
AccessAccessMột enum đại diện cho các lớp người dùng có thể truy cập vào một tệp hoặc thư mục, ngoài bất kỳ người dùng riêng lẻ nào đã được cấp quyền truy cập một cách rõ ràng.
PermissionPermissionMột enum đại diện cho các quyền được cấp cho người dùng có thể truy cập vào một tệp hoặc thư mục, ngoài bất kỳ người dùng riêng lẻ nào đã được cấp quyền truy cập một cách rõ ràng.

Phương thức

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

File

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addCommenter(emailAddress)FileThêm người dùng đã cho vào danh sách người bình luận cho File.
addCommenter(user)FileThêm người dùng đã cho vào danh sách người bình luận cho File.
addCommenters(emailAddresses)FileThêm mảng người dùng đã cho vào danh sách người bình luận cho File.
addEditor(emailAddress)FileThêm người dùng đã cho vào danh sách người chỉnh sửa cho File.
addEditor(user)FileThêm người dùng đã cho vào danh sách người chỉnh sửa cho File.
addEditors(emailAddresses)FileThêm mảng người dùng đã cho vào danh sách người chỉnh sửa cho File.
addViewer(emailAddress)FileThêm người dùng đã cho vào danh sách người xem của File.
addViewer(user)FileThêm người dùng đã cho vào danh sách người xem của File.
addViewers(emailAddresses)FileThêm mảng người dùng đã cho vào danh sách người xem cho File.
getAccess(email)PermissionLấy quyền được cấp cho một người dùng cụ thể.
getAccess(user)PermissionLấy quyền được cấp cho một người dùng cụ thể.
getAs(contentType)BlobTrả về dữ liệu bên trong đối tượng này dưới dạng một blob được chuyển đổi sang loại nội dung đã chỉ định.
getBlob()BlobTrả về dữ liệu bên trong đối tượng này dưới dạng một blob.
getDateCreated()DateLấy ngày tạo File.
getDescription()StringLấy nội dung mô tả cho File.
getDownloadUrl()StringLấ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()StringLấy mã nhận dạng của File.
getLastUpdated()DateLấy ngày File được cập nhật gần đây nhất.
getMimeType()StringLấy loại MIME của tệp.
getName()StringLấy tên của File.
getOwner()UserLấy chủ sở hữu tệp.
getParents()FolderIteratorLấy một tập hợp các thư mục là thư mục mẹ ngay lập tức của File.
getResourceKey()StringLấ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 đường liên kết.
getSecurityUpdateEligible()BooleanCho biết liệu 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 đường liên kết hay không.
getSecurityUpdateEnabled()BooleanCho biết liệu File này có yêu cầu khoá tài nguyên để truy cập khi được chia sẻ bằng đường liên kết hay không.
getSharingAccess()AccessLấy lớp người dùng có thể truy cập vào File, ngoài những người dùng riêng lẻ đã được cấp quyền truy cập một cách rõ ràng.
getSharingPermission()PermissionLấy quyền được cấp cho những người dùng có thể truy cập vào File, ngoài những người dùng riêng lẻ đã được cấp quyền truy cập một cách rõ ràng.
getSize()IntegerLấy số byte được dùng để lưu trữ File trong Drive.
getTargetId()StringNếu đây là một Lối tắt, hàm sẽ trả về mã nhận dạng của mục mà lối tắt đó trỏ đến.
getTargetMimeType()StringNếu đây là một Lối tắt, hãy trả về loại MIME của mục mà lối tắt đó trỏ đến.
getTargetResourceKey()StringNếu tệp là một lối tắt, hàm này sẽ trả về khoá tài nguyên của mục mà lối tắt đó trỏ đến.
getThumbnail()Blob|nullLấy hình thu nhỏ của tệp hoặc null nếu không có hình thu nhỏ.
getUrl()StringLấy URL có thể dùng để mở File trong một Ứng dụng của Google như Drive hoặc Tài liệu.
getViewers()User[]Lấy danh sách người xem và người nhận xét cho File này.
isShareableByEditors()BooleanXá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()BooleanXác định xem File có được gắn dấu sao trong Drive của người dùng hay không.
isTrashed()BooleanXác định xem File có nằm trong thùng rác của Drive của người dùng hay không.
makeCopy()FileTạo bản sao của tệp.
makeCopy(destination)FileTạo một bản sao của tệp trong thư mục đích.
makeCopy(name)FileTạo bản sao của tệp và đặt tên cho tệp đó bằng tên bạn cung cấp.
makeCopy(name, destination)FileTạo bản sao của tệp trong thư mục đích và đặt tên cho tệp đó bằng tên đã cung cấp.
moveTo(destination)FileDi chuyển mục này đến thư mục đích được cung cấp.
removeCommenter(emailAddress)FileXoá người dùng đã cho khỏi danh sách người bình luận của File.
removeCommenter(user)FileXoá người dùng đã cho khỏi danh sách người bình luận của File.
removeEditor(emailAddress)FileXoá người dùng đã cho khỏi danh sách người chỉnh sửa của File.
removeEditor(user)FileXoá người dùng đã cho khỏi danh sách người chỉnh sửa của File.
removeViewer(emailAddress)FileXoá người dùng đã cho khỏi danh sách người xem và người bình luận của File.
removeViewer(user)FileXoá người dùng đã cho khỏi danh sách người xem và người bình luận của File.
revokePermissions(emailAddress)FileThu hồi quyền truy cập vào File đã cấp cho người dùng cụ thể.
revokePermissions(user)FileThu hồi quyền truy cập vào File đã cấp cho người dùng cụ thể.
setContent(content)FileGhi đè nội dung của tệp bằng một nội dung thay thế nhất định.
setDescription(description)FileĐặt nội dung mô tả cho File.
setName(name)FileĐặt tên cho File.
setOwner(emailAddress)FileThay đổi chủ sở hữu của File.
setOwner(user)FileThay đổi chủ sở hữu của File.
setSecurityUpdateEnabled(enabled)FileĐặt xem File có yêu cầu khoá tài nguyên để truy cập khi được chia sẻ bằng đường liên kết hay không.
setShareableByEditors(shareable)FileĐặt 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 nhóm người dùng có thể truy cập vào File và những quyền mà những người dùng đó được cấp, ngoài những người dùng riêng lẻ đã được cấp quyền truy cập một cách rõ ràng.
setStarred(starred)FileĐặt xem File có được gắn dấu sao trong Drive của người dùng hay không.
setTrashed(trashed)FileĐặt xem File có nằm trong thùng rác của Drive của người dùng hay không.

FileIterator

Phương thức

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

Folder

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
addEditor(emailAddress)FolderThêm người dùng đã cho vào danh sách người chỉnh sửa cho Folder.
addEditor(user)FolderThêm người dùng đã cho vào danh sách người chỉnh sửa cho Folder.
addEditors(emailAddresses)FolderThêm mảng người dùng đã cho vào danh sách người chỉnh sửa cho Folder.
addViewer(emailAddress)FolderThêm người dùng đã cho vào danh sách người xem của Folder.
addViewer(user)FolderThêm người dùng đã cho vào danh sách người xem của Folder.
addViewers(emailAddresses)FolderThêm mảng người dùng đã cho vào danh sách người xem cho Folder.
createFile(blob)FileTạo một tệp trong thư mục hiện tại từ một Blob cho trước của dữ liệu tuỳ ý.
createFile(name, content)FileTạo một tệp văn bản trong thư mục hiện tại với tên và nội dung đã cho.
createFile(name, content, mimeType)FileTạ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)FolderTạo một thư mục trong thư mục hiện tại bằng tên đã cho.
createShortcut(targetId)FileTạo lối tắt đến mã nhận dạng mục trên Drive đã cung cấp và trả về lối tắt đó.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTạo lối tắt đến mã nhận dạng mục và khoá tài nguyên được cung cấp trên Drive, rồi trả về lối tắt đó.
getAccess(email)PermissionLấy quyền được cấp cho một người dùng cụ thể.
getAccess(user)PermissionLấy quyền được cấp cho một người dùng cụ thể.
getDateCreated()DateLấy ngày tạo Folder.
getDescription()StringLấ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()FileIteratorLấy một tập hợp gồm tất cả các tệp là thành phần con của thư mục hiện tại.
getFilesByName(name)FileIteratorLấy một tập hợp gồm tất cả các tệp là thành phần con của thư mục hiện tại và có tên đã cho.
getFilesByType(mimeType)FileIteratorLấy một tập hợp gồm tất cả các tệp là thành phần con của thư mục hiện tại và có loại MIME đã cho.
getFolders()FolderIteratorLấy một tập hợp gồm tất cả các thư mục là thư mục con của thư mục hiện tại.
getFoldersByName(name)FolderIteratorLấy một tập hợp gồm 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 đã cho.
getId()StringLấy mã nhận dạng của Folder.
getLastUpdated()DateLấy ngày Folder được cập nhật gần đây nhất.
getName()StringLấy tên của Folder.
getOwner()UserLấy chủ sở hữu của Folder này.
getParents()FolderIteratorLấy một tập hợp các thư mục là thư mục mẹ ngay lập tức của Folder.
getResourceKey()StringLấ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 đường liên kết.
getSecurityUpdateEligible()BooleanCho biết liệu 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 đường liên kết hay không.
getSecurityUpdateEnabled()BooleanCho biết liệu Folder này có yêu cầu khoá tài nguyên để truy cập khi được chia sẻ bằng đường liên kết hay không.
getSharingAccess()AccessLấy lớp người dùng có thể truy cập vào Folder, ngoài những người dùng riêng lẻ đã được cấp quyền truy cập một cách rõ ràng.
getSharingPermission()PermissionLấy quyền được cấp cho những người dùng có thể truy cập vào Folder, ngoài những người dùng riêng lẻ đã được cấp quyền truy cập một cách rõ ràng.
getSize()IntegerLấy số byte được dùng để lưu trữ Folder trong Drive.
getUrl()StringLấy URL có thể dùng để mở Folder trong một Ứng dụng của Google như Drive hoặc Tài liệu.
getViewers()User[]Lấy danh sách người xem và người nhận xét cho Folder này.
isShareableByEditors()BooleanXá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()BooleanXác định xem Folder có được gắn dấu sao trong Drive của người dùng hay không.
isTrashed()BooleanXác định xem Folder có nằm trong thùng rác của Drive của người dùng hay không.
moveTo(destination)FolderDi chuyển mục này đến thư mục đích được cung cấp.
removeEditor(emailAddress)FolderXoá người dùng đã cho khỏi danh sách người chỉnh sửa của Folder.
removeEditor(user)FolderXoá người dùng đã cho khỏi danh sách người chỉnh sửa của Folder.
removeViewer(emailAddress)FolderXoá người dùng đã cho khỏi danh sách người xem và người bình luận của Folder.
removeViewer(user)FolderXoá người dùng đã cho khỏi danh sách người xem và người bình luận của Folder.
revokePermissions(emailAddress)FolderThu hồi quyền truy cập vào Folder đã cấp cho người dùng cụ thể.
revokePermissions(user)FolderThu hồi quyền truy cập vào Folder đã cấp cho người dùng cụ thể.
searchFiles(params)FileIteratorLấy một tập hợp gồm tất cả các tệp là thư mục con của thư mục hiện tại và khớp với tiêu chí tìm kiếm đã cho.
searchFolders(params)FolderIteratorLấy một tập hợp gồm 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 tiêu chí tìm kiếm đã cho.
setDescription(description)FolderĐặt nội dung mô tả cho Folder.
setName(name)FolderĐặt tên cho Folder.
setOwner(emailAddress)FolderThay đổi chủ sở hữu của Folder.
setOwner(user)FolderThay đổi chủ sở hữu của Folder.
setSecurityUpdateEnabled(enabled)FolderĐặt xem Folder có yêu cầu khoá tài nguyên để truy cập khi được chia sẻ bằng đường liên kết hay không.
setShareableByEditors(shareable)FolderĐặt 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 nhóm người dùng có thể truy cập vào Folder và những quyền mà những người dùng đó được cấp, ngoài những người dùng riêng lẻ đã được cấp quyền truy cập một cách rõ ràng.
setStarred(starred)FolderĐặt xem Folder có được gắn dấu sao trong Drive của người dùng hay không.
setTrashed(trashed)FolderĐặt xem Folder có nằm trong thùng rác của Drive của người dùng hay không.

FolderIterator

Phương thức

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

Permission

Thuộc tính

Thuộc tínhLoạiMô tả
VIEWEnumNgườ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/thư mục đó.
EDITEnumNgười dùng có quyền truy cập vào tệp hoặc thư mục có thể chỉnh sửa tệp hoặc thư mục đó.
COMMENTEnumNgườ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/thư mục đó.
OWNEREnumNgười dùng sở hữu tệp hoặc thư mục.
ORGANIZEREnumNgười dùng có thể sắp xếp các tệp và thư mục trong bộ nhớ dùng chung.
FILE_ORGANIZEREnumNhững người dùng có thể chỉnh sửa, xoá vào thùng rác và di chuyển nội dung trong bộ nhớ dùng chung.
NONEEnumNgườ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ứcKiểu dữ liệu trả vềMô tả ngắn
getDomain()String|nullLấy tên miền được liên kết với tài khoản của người dùng.
getEmail()String|nullLấy địa chỉ email của người dùng.
getName()String|nullLấy tên của người dùng.
getPhotoUrl()String|nullLấy URL cho ảnh của người dùng.