Drive Service

Google Drive

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

// 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());
}

Lớp

TênMô tả ngắn
AccessEnum biểu thị 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ỳ cá nhân người dùng nào đã được cấp quyền truy cập rõ ràng.
DriveAppCho 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.
FileMột tệp trong Google Drive.
FileIteratorMộ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 lớn.
FolderMột thư mục trong Google Drive.
FolderIteratorĐố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 lớn có thể lặp lại.
PermissionEnum biểu thị các quyền được cấp cho những người dùng có thể truy cập vào một tệp hoặc thư mục, ngoài mọi người dùng cá nhân đã được cấp quyền truy cập 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 cũng có thể tìm và truy cập.
ANYONE_WITH_LINKEnumBất cứ ai có đường 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 và truy cập.
DOMAIN_WITH_LINKEnumNhững người trong miền của bạn có đường liên kết 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ả
AccessAccessEnum biểu thị 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ỳ cá nhân người dùng nào đã được cấp quyền truy cập rõ ràng.
PermissionPermissionEnum biểu thị các quyền được cấp cho những người dùng có thể truy cập vào một tệp hoặc thư mục, ngoài mọi người dùng cá nhân đã được cấp quyền truy cập rõ ràng.

Phương pháp

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

File

Phương pháp

Phương thứcLoại 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 nhận xét cho File.
addCommenter(user)FileThêm người dùng đã cho vào danh sách người nhận xét cho File.
addCommenters(emailAddresses)FileThêm một loạt người dùng vào danh sách người nhận xét cho File.
addEditor(emailAddress)FileThêm người dùng đã cho vào danh sách trình chỉnh sửa cho File.
addEditor(user)FileThêm người dùng đã cho vào danh sách trình chỉnh sửa cho File.
addEditors(emailAddresses)FileThêm mảng người dùng đã cho vào danh sách trình chỉnh sửa cho File.
addViewer(emailAddress)FileThêm người dùng đã cho vào danh sách người xem cho File.
addViewer(user)FileThêm người dùng đã cho vào danh sách người xem cho File.
addViewers(emailAddresses)FileThêm mảng người dùng nhất định vào danh sách người xem cho File.
getAccess(email)PermissionNhận quyền được cấp cho người dùng đã cho.
getAccess(user)PermissionNhận quyền được cấp cho người dùng đã cho.
getAs(contentType)BlobTrả về dữ liệu bên trong đối tượng này dưới dạng blob được chuyển đổi thành loại nội dung được chỉ định.
getBlob()BlobTrả về dữ liệu bên trong đối tượng này dưới dạng blob.
getDateCreated()DateLấy ngày tạo File.
getDescription()StringLấy thông tin 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 cập nhật File 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 của File.
getParents()FolderIteratorNhận một tập hợp các thư mục là thực thể mẹ ngay trong File.
getResourceKey()StringLấy khoá tài nguyên của File cần thiết để truy cập các mục được chia sẻ bằng một đường liên kết.
getSecurityUpdateEligible()BooleanNhận được 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 hay không khi được chia sẻ bằng đường liên kết.
getSecurityUpdateEnabled()BooleanNhận được liệu 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 đường liên kết.
getSharingAccess()AccessLấy lớp người dùng nào có thể truy cập File, ngoài bất kỳ cá nhân người dùng nào đã được cấp quyền truy cập rõ ràng.
getSharingPermission()PermissionNhận quyền được cấp cho những người dùng có thể truy cập File, ngoài tất cả người dùng cá nhân đã được cấp quyền truy cập rõ ràng.
getSize()IntegerLấy số byte dùng để lưu trữ File trong Drive.
getTargetId()StringNếu đây là phím tắt, hãy trả về mã nhận dạng của mục mà nó trỏ đến.
getTargetMimeType()StringNếu đây là phím tắt, hãy trả về loại MIME của mục trỏ đến.
getTargetResourceKey()StringNếu tệp là lối tắt, hãy trả về khoá tài nguyên của mục mà tệp trỏ đến.
getThumbnail()BlobLấy hình thu nhỏ của tệp hoặc null nếu không có hình thu nhỏ nào.
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 một bản sao của tệp và đặt tên cho tệp bằng tên đã cung cấp.
makeCopy(name, destination)FileTạ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 đã cung cấp.
moveTo(destination)FileChuyển mục này vào thư mục đích được cung cấp.
removeCommenter(emailAddress)FileXoá người dùng cụ thể khỏi danh sách người nhận xét cho File.
removeCommenter(user)FileXoá người dùng cụ thể khỏi danh sách người nhận xét cho File.
removeEditor(emailAddress)FileXoá người dùng đã chỉ định khỏi danh sách trình chỉnh sửa của File.
removeEditor(user)FileXoá người dùng đã chỉ định khỏi danh sách trình chỉnh sửa của File.
removeViewer(emailAddress)FileXóa người dùng cụ thể khỏi danh sách người xem và người nhận xét cho File.
removeViewer(user)FileXóa người dùng cụ thể khỏi danh sách người xem và người nhận xét cho File.
revokePermissions(user)FileThu hồi quyền truy cập vào File được cấp cho người dùng đã cho.
revokePermissions(user)FileThu hồi quyền truy cập vào File được cấp cho người dùng đã cho.
setContent(content)FileGhi đè nội dung của tệp bằng một đoạn thay thế.
setDescription(description)FileĐặt phần 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 hay không khi được chia sẻ bằng đường liên kết.
setShareableByEditors(shareable)FileThiết lập liệu người dùng có quyền chỉnh sửa đối với File được phép chia sẻ với người dùng khác hay thay đổi quyền đó.
setSharing(accessType, permissionType)FileĐặt lớp người dùng nào có thể truy cập vào File và những quyền mà người dùng đó được cấp, ngoài những người dùng cá nhân đã được cấp quyền truy cập 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 liệu File có nằm trong thùng rác của Drive của người dùng hay không.

FileIterator

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
getContinuationToken()StringLấy mã thông báo có thể dùng để tiếp tục lặp lại sau này.
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 pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
addEditor(emailAddress)FolderThêm người dùng đã cho vào danh sách trình chỉnh sửa cho Folder.
addEditor(user)FolderThêm người dùng đã cho vào danh sách trình chỉnh sửa cho Folder.
addEditors(emailAddresses)FolderThêm mảng người dùng đã cho vào danh sách trình chỉnh sửa cho Folder.
addViewer(emailAddress)FolderThêm người dùng đã cho vào danh sách người xem cho Folder.
addViewer(user)FolderThêm người dùng đã cho vào danh sách người xem cho Folder.
addViewers(emailAddresses)FolderThêm mảng người dùng nhất định 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 dữ liệu tuỳ ý nhất định.
createFile(name, content)FileTạo 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)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 có tên được cung cấp.
createShortcut(targetId)FileTạo lối tắt đến mã mục trên Drive đã cung cấp và trả lại mã đó.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTạo một lối tắt đến mã mục và tài nguyên Drive được cung cấp, sau đó trả về.
getAccess(email)PermissionNhận quyền được cấp cho người dùng đã cho.
getAccess(user)PermissionNhận quyền được cấp cho người dùng đã cho.
getDateCreated()DateLấy ngày tạo Folder.
getDescription()StringLấy thông tin mô tả cho Folder.
getEditors()User[]Lấy danh sách người chỉnh sửa cho Folder này.
getFiles()FileIteratorLấy tập hợp tất cả tệp là thư mục con của thư mục hiện tại.
getFilesByName(name)FileIteratorLấy tập hợp của tất cả tệp là thư mục con của thư mục hiện tại và có tên được cung cấp.
getFilesByType(mimeType)FileIteratorLấy tập hợp tất cả tệp là thư mục con của thư mục hiện tại và có loại MIME đã cho.
getFolders()FolderIteratorLấy tập hợp của tất cả thư mục là thư mục con của thư mục hiện tại.
getFoldersByName(name)FolderIteratorLấy tập hợp của tất cả thư mục là thư mục con của thư mục hiện tại và có tên được đặt.
getId()StringLấy mã nhận dạng của Folder.
getLastUpdated()DateLấy ngày cập nhật Folder gần đây nhất.
getName()StringLấy tên của Folder.
getOwner()UserLấy chủ sở hữu của Folder.
getParents()FolderIteratorNhận một tập hợp các thư mục là thực thể mẹ ngay trong Folder.
getResourceKey()StringLấy khoá tài nguyên của Folder cần thiết để truy cập các mục được chia sẻ bằng một đường liên kết.
getSecurityUpdateEligible()BooleanNhận được 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 hay không khi được chia sẻ bằng đường liên kết.
getSecurityUpdateEnabled()BooleanNhận được liệu 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 đường liên kết.
getSharingAccess()AccessLấy lớp người dùng nào có thể truy cập Folder, ngoài bất kỳ cá nhân người dùng nào đã được cấp quyền truy cập rõ ràng.
getSharingPermission()PermissionNhận quyền được cấp cho những người dùng có thể truy cập Folder, ngoài tất cả người dùng cá nhân đã được cấp quyền truy cập rõ ràng.
getSize()IntegerLấy số byte 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)FolderChuyển mục này vào thư mục đích được cung cấp.
removeEditor(emailAddress)FolderXoá người dùng đã chỉ định khỏi danh sách trình chỉnh sửa của Folder.
removeEditor(user)FolderXoá người dùng đã chỉ định khỏi danh sách trình chỉnh sửa của Folder.
removeViewer(emailAddress)FolderXóa người dùng cụ thể khỏi danh sách người xem và người nhận xét cho Folder.
removeViewer(user)FolderXóa người dùng cụ thể khỏi danh sách người xem và người nhận xét cho Folder.
revokePermissions(user)FolderThu hồi quyền truy cập vào Folder được cấp cho người dùng đã cho.
revokePermissions(user)FolderThu hồi quyền truy cập vào Folder được cấp cho người dùng đã cho.
searchFiles(params)FileIteratorLấy tập hợp của tất cả tệp là phần tử con của thư mục hiện tại và khớp với tiêu chí tìm kiếm cụ thể.
searchFolders(params)FolderIteratorLấy tập hợp của tất 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 nhất định.
setDescription(description)FolderĐặt phần 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 hay không khi được chia sẻ bằng đường liên kết.
setShareableByEditors(shareable)FolderThiết lập liệu người dùng có quyền chỉnh sửa đối với Folder được phép chia sẻ với người dùng khác hay thay đổi quyền đó.
setSharing(accessType, permissionType)FolderĐặt lớp người dùng nào có thể truy cập vào Folder và những quyền mà người dùng đó được cấp, ngoài những người dùng cá nhân đã được cấp quyền truy cập 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 liệu Folder có nằm trong thùng rác của Drive của người dùng hay không.

FolderIterator

Phương pháp

Phương thứcLoại dữ liệu trả vềMô tả ngắn
getContinuationToken()StringLấy mã thông báo có thể dùng để tiếp tục lặp lại sau này.
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ả
VIEWEnumNhững người dùng có thể truy cập tệp hoặc thư mục chỉ có thể xem hoặc sao chép tệp hoặc thư mục đó.
EDITEnumNhững người dùng có thể truy cập vào tệp hoặc thư mục đó sẽ có thể chỉnh sửa tệp đó.
COMMENTEnumNhững người dùng có thể 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 đó.
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 một bộ nhớ dùng chung.
FILE_ORGANIZEREnumNgười dùng có thể chỉnh sửa, chuyển và chuyển nội dung vào bộ nhớ dùng chung.
NONEEnumNgười dùng không có bất kỳ quyền nào đối với tệp hoặc thư mục đó.

User

Phương pháp

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