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.
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 API Drive theo cách thủ công. Trong dự án Cloud tiêu chuẩn, hãy 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 Google Drive 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ên | Mô tả ngắn |
|---|---|
Access | Mộ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 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 các tệp và thư mục trong Google Drive. |
File | Một tệp trong Google Drive. |
FileIterator | Một trình 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ể lớn. |
Folder | Một thư mục trong Google Drive. |
FolderIterator | Mộ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. |
Permission | Mộ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 cá nhân nào đã được cấp quyền truy cập một cách rõ ràng. |
User | Mộ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ính | Loại | Mô tả |
|---|---|---|
ANYONE | Enum | Bất kỳ ai trên 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 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
| Thuộc tính | Loại | Mô tả |
|---|---|---|
Access | Access | Mộ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 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 đạ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 cá nhân nào đã được cấp quyền truy cập một cách rõ ràng. |
Phương thức
| Phương thức | Loại dữ liệu trả về | Mô tả ngắn |
|---|---|---|
continueFileIterator(continuationToken) | FileIterator | Tiếp tục 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 trước đó. |
continueFolderIterator(continuationToken) | FolderIterator | Tiế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ừ 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 nhất định chứa dữ liệu tuỳ ý. |
createFile(name, content) | File | Tạo một tệp văn bản trong thư mục gốc của Drive của người dùng với tên và nội dung đã cho. |
createFile(name, content, mimeType) | File | Tạ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) | Folder | Tạo một thư mục trong thư mục gốc của Drive của người dùng có tên đã cho. |
createShortcut(targetId) | File | Tạ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) | File | Tạo lối tắt đến mã mục và khoá tài nguyên trên Drive đã cung cấp rồi trả về lối tắt đó. |
enforceSingleParent(value) | void | Bật hoặc tắt hành vi enforceSingleParent cho tất cả các lệnh gọi ảnh hưởng đến phần tử mẹ. |
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 tập hợp tất cả tệp trong Drive của người dùng. |
getFilesByName(name) | FileIterator | Lấy tập hợp tất cả tệp có tên đã cho trong Drive của người dùng. |
getFilesByType(mimeType) | FileIterator | Lấy tập hợp tất cả tệp trong Drive của người dùng có loại MIME nhất định. |
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 tập hợp tất cả thư mục trong Drive của người dùng. |
getFoldersByName(name) | FolderIterator | Lấy tập hợp tất cả thư mục có tên đã cho trong Drive của người dùng. |
getRootFolder() | Folder | Lấy thư mục ở thư mục gốc của 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 | Lấy tập hợp tất cả tệp trong thùng rác của Drive của người dùng. |
getTrashedFolders() | FolderIterator | Lấy tập hợp tất cả thư mục trong thùng rác của Drive của người dùng. |
searchFiles(params) | FileIterator | Lấ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) | FolderIterator | Lấy tập hợp tất 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ức | Loại dữ liệu trả về | Mô tả ngắn |
|---|---|---|
addCommenter(emailAddress) | File | Thêm người dùng đã cho vào danh sách người bình luận cho File. |
addCommenter(user) | File | Thêm người dùng đã cho vào danh sách người bình luận cho File. |
addCommenters(emailAddresses) | File | Thêm mảng người dùng đã cho vào danh sách người bình luận cho File. |
addEditor(emailAddress) | File | Thêm người dùng đã cho vào danh sách người chỉnh sửa cho File. |
addEditor(user) | File | Thêm người dùng đã cho vào danh sách người chỉnh sửa cho File. |
addEditors(emailAddresses) | File | Thêm mảng người dùng đã cho vào danh sách người chỉnh sửa cho File. |
addViewer(emailAddress) | File | Thêm người dùng đã cho vào danh sách người xem của File. |
addViewer(user) | File | Thêm người dùng đã cho 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 cho File. |
getAccess(email) | Permission | Lấy quyền được cấp cho một người dùng cụ thể. |
getAccess(user) | Permission | Lấy quyền được cấp cho một 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 đã chỉ định. |
getBlob() | Blob | Trả về dữ liệu bên trong đối tượng này dưới dạng 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 trình 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 gần đây nhất File được cập 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ư mục 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 đường liên kết. |
getSecurityUpdateEligible() | Boolean | Xác định 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 đường liên kết hay không. |
getSecurityUpdateEnabled() | Boolean | Xác định xem 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() | Access | Xác định lớp người dùng nào có thể truy cập vào File, ngoài những người dùng cá nhân đã được cấp quyền truy cập 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 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() | Integer | Lấy số byte dùng để lưu trữ File trong Drive. |
getTargetId() | String | Nếu đây là một Lối tắt, hãy trả về mã nhận dạng của mục mà lối tắt trỏ đến. |
getTargetMimeType() | String | Nế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() | String | Nế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() | Blob | Lấy hình thu nhỏ của tệp hoặc null nếu không có hình thu nhỏ. |
getUrl() | String | Lấ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() | 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 hay 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ó nằm trong thùng rác của 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 một bản sao của tệp trong thư mục đích. |
makeCopy(name) | File | Tạo bản sao của tệp và đặt tên cho bản sao đó bằng tên đã cung cấp. |
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 bản sao đó bằng tên được cung cấp. |
moveTo(destination) | File | Di chuyển mục này đến thư mục đích đã cung cấp. |
removeCommenter(emailAddress) | File | Xoá người dùng đã cho khỏi danh sách người bình luận cho File. |
removeCommenter(user) | File | Xoá người dùng đã cho khỏi danh sách người bình luận cho File. |
removeEditor(emailAddress) | File | Xoá người dùng đã cho khỏi danh sách trình chỉnh sửa cho File. |
removeEditor(user) | File | Xoá người dùng đã cho khỏi danh sách trình chỉnh sửa cho File. |
removeViewer(emailAddress) | File | Xoá người dùng đã cho khỏi danh sách người xem và người bình luận cho File. |
removeViewer(user) | File | Xoá người dùng đã cho khỏi danh sách người xem và người bình luận cho File. |
revokePermissions(emailAddress) | File | Thu hồi quyền truy cập vào File đã cấp cho người dùng cụ thể. |
revokePermissions(user) | File | Thu hồi quyền truy cập vào File đã cấp cho người dùng cụ thể. |
setContent(content) | File | Ghi đè 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) | 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 | Đặ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 hay thay đổi quyền hay không. |
setSharing(accessType, permissionType) | File | Đặt loại người dùng nào có thể truy cập vào File và những quyền nào được cấp cho những người dùng đó, ngoài những người dùng riêng lẻ đã đượ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 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ức | Loại 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. |
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 bộ sưu tập tệp hoặc thư mục. |
Folder
Phương thức
| Phương thức | Loại 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 cho Folder. |
addEditor(user) | Folder | Thêm người dùng đã cho vào danh sách người chỉnh sửa cho Folder. |
addEditors(emailAddresses) | Folder | Thêm mảng người dùng đã cho vào danh sách người chỉnh sửa cho Folder. |
addViewer(emailAddress) | Folder | Thêm người dùng đã cho vào danh sách người xem của Folder. |
addViewer(user) | Folder | Thêm người dùng đã cho 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 cho Folder. |
createFile(blob) | File | Tạo một tệp trong thư mục hiện tại từ một Blob nhất định của dữ liệu tuỳ ý. |
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 có tên đã cho. |
createShortcut(targetId) | File | Tạ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) | File | Tạo lối tắt đến mã mục và khoá tài nguyên trên Drive đã cung cấp rồi trả về lối tắt đó. |
getAccess(email) | Permission | Lấy quyền được cấp cho một người dùng cụ thể. |
getAccess(user) | Permission | Lấy quyền được cấp cho một 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 trình chỉnh sửa cho Folder này. |
getFiles() | FileIterator | Lấy tập hợp tất cả các tệp là con của thư mục hiện tại. |
getFilesByName(name) | FileIterator | Lấy tập hợp tất cả tệp là con của thư mục hiện tại và có tên đã cho. |
getFilesByType(mimeType) | FileIterator | Lấy tập hợp tất cả tệp là tệp con của thư mục hiện tại và có loại MIME nhất định. |
getFolders() | FolderIterator | Lấy tập hợp tất cả thư mục con của thư mục hiện tại. |
getFoldersByName(name) | FolderIterator | Lấy tập hợp tất cả thư mục con của thư mục hiện tại và có tên đã cho. |
getId() | String | Lấy mã nhận dạng của Folder. |
getLastUpdated() | Date | Lấy ngày gần đây nhất Folder được cập nhật. |
getName() | String | Lấy tên của Folder. |
getOwner() | User | Lấy 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ư mục 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 đường liên kết. |
getSecurityUpdateEligible() | Boolean | Xác định 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 đường liên kết hay không. |
getSecurityUpdateEnabled() | Boolean | Xác định xem 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() | Access | Xác định lớp người dùng nào có thể truy cập vào Folder, ngoài những người dùng cá nhân đã được cấp quyền truy cập 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 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() | 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 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() | 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 hay 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ó nằm trong thùng rác của Drive của người dùng hay không. |
moveTo(destination) | Folder | Di chuyển mục này đến thư mục đích đã cung cấp. |
removeEditor(emailAddress) | Folder | Xoá người dùng đã cho khỏi danh sách trình chỉnh sửa cho Folder. |
removeEditor(user) | Folder | Xoá người dùng đã cho khỏi danh sách trình chỉnh sửa cho Folder. |
removeViewer(emailAddress) | Folder | Xoá người dùng đã cho khỏi danh sách người xem và người bình luận cho Folder. |
removeViewer(user) | Folder | Xoá người dùng đã cho khỏi danh sách người xem và người bình luận cho Folder. |
revokePermissions(emailAddress) | Folder | Thu hồi quyền truy cập vào Folder đã cấp cho người dùng cụ thể. |
revokePermissions(user) | Folder | Thu hồi quyền truy cập vào Folder đã cấp cho người dùng cụ thể. |
searchFiles(params) | FileIterator | Lấy 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à khớp với tiêu chí tìm kiếm đã cho. |
searchFolders(params) | FolderIterator | Lấy tập hợp 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 đã cho. |
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 | Đặ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 hay thay đổi quyền hay không. |
setSharing(accessType, permissionType) | Folder | Đặt loại người dùng nào có thể truy cập vào Folder và những quyền nào được cấp cho những người dùng đó, ngoài những người dùng riêng lẻ đã đượ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 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ức | Loại 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. |
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 bộ sưu tập tệp hoặc thư mục. |
Permission
Thuộc tính
| Thuộc tính | Loại | Mô tả |
|---|---|---|
VIEW | Enum | Những người dùng có thể 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 đó. |
EDIT | Enum | Nhữ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 hoặc thư mục đó. |
COMMENT | Enum | Nhữ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 đó. |
OWNER | Enum | Người dùng sở hữu tệp hoặc thư mục đó. |
ORGANIZER | Enum | 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 đối với tệp hoặc thư mục. |
User
Phương thức
| Phương thức | Loại 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 cho ảnh của người dùng. |