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 Cloud chuẩn thay vì một dự án Cloud mặc định, bạn phải bật API Drive theo cách thủ công. Trong dự án Google Cloud chuẩn của bạn, hãy bật API Drive:
Mã mẫu sau đây biểu thị cách ghi nhật ký tên của từng tệp trong Thư mục Drive của tôi:// 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 từng người dùng những người dùng đã đượ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 một tập hợp tệp có thể lớn. |
Folder | Một thư mục trong Google Drive. |
FolderIterator | Đối tượng cho phép tập lệnh lặp lại một tập hợp thư mục có thể lớn. |
Permission | Một enum thể hiện 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, 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. |
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 có kết nối Internet đều có thể tìm và truy cập. |
ANYONE_WITH_LINK | Enum | Bất cứ ai có đường liên kết đều có thể truy cập. |
DOMAIN | Enum | Những 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 từng người dùng những người dùng đã được cấp quyền truy cập một cách rõ ràng. |
Permission | Permission | Một enum thể hiện 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, 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. |
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 mã thông báo tiếp tục từ một biến 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 gồm 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 có tên và nội dung cụ thể. |
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 với tên được cung cấp. |
createShortcut(targetId) | File | Tạo lối tắt đến mã mục được cung cấp trên Drive rồi trả về mã đó. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Tạo lối tắt đến mã mục và khoá tài nguyên được cung cấp trên Drive rồi trả về. |
enforceSingleParent(value) | void | Bật hoặc vô hiệu hoá việc thực thi hành vi SingleParent cho tất cả các lệnh gọi ảnh hưởng đến mục gố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 một 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 một tập hợp tất cả các tệp trong Drive của người dùng có loại MIME cho sẵn. |
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ả thư mục trong Drive của người dùng. |
getFoldersByName(name) | 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 có cùng tên. |
getRootFolder() | Folder | Lấy thư mục này ở 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 một 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 một 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 một tập hợp tất cả các tệp trong Drive của người dùng khớp với nội dung tìm kiếm cụ thể tiêu chí. |
searchFolders(params) | FolderIterator | Lấy một tập hợp tất cả thư mục trong Drive của người dùng khớp với nội dung tìm kiếm đã cho tiêu chí. |
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 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 cụ thể vào danh sách người chỉnh sửa cho File. |
addEditor(user) | File | Thêm người dùng cụ thể vào danh sách người chỉnh sửa cho File. |
addEditors(emailAddresses) | File | Thêm mảng người dùng nhất định vào danh sách người chỉnh sửa cho File. |
addViewer(emailAddress) | File | Thêm người dùng cụ thể vào danh sách người xem cho File. |
addViewer(user) | File | Thêm người dùng cụ thể vào danh sách người xem cho File. |
addViewers(emailAddresses) | File | Thêm mảng người dùng nhất định vào danh sách người xem cho 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 sang 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 | Xem 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 | Xem ngày gần đây nhất mà 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 | Xem 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 một liên kết. |
getSecurityUpdateEligible() | Boolean | Xem liệu File này có đủ điều kiện áp dụng bản cập nhật bảo mật hay không
cần có một khoá tài nguyên để truy cập khi khoá này được chia sẻ bằng đường liên kết. |
getSecurityUpdateEnabled() | Boolean | Tìm hiểu xem 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 liên kết. |
getSharingAccess() | Access | Lấy lớp người dùng có thể truy cập vào File, ngoài từng cá nhân
những người dùng đã được cấp quyền truy cập một cách rõ ràng. |
getSharingPermission() | Permission | Được cấp quyền cho những người dùng 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 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à 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() | String | Nếu đây là lối tắt, hàm sẽ 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à nó 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 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 File có được phép
chia sẻ với người dùng khác hoặc thay đổi quyền truy cập. |
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 trên 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 bản sao của tệp và đặt tên cho tệp bằng tên đã cung cấp. |
makeCopy(name, destination) | File | Tạ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) | File | Chuyển mục này đến thư mục đích được cung cấp. |
removeCommenter(emailAddress) | File | Xoá người dùng cụ thể khỏi danh sách người nhận xét cho File. |
removeCommenter(user) | File | Xoá người dùng cụ thể khỏi danh sách người nhận xét cho 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 đối với 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 đối với File. |
revokePermissions(emailAddress) | File | Thu hồi quyền truy cập vào File được cấp cho người dùng cụ thể. |
revokePermissions(user) | File | Thu hồi quyền truy cập vào File được cấp cho người dùng cụ thể. |
setContent(content) | File | Ghi đè nội dung của tệp bằng một đường liên kết thay thế cụ thể. |
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 liên kết. |
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ẻ hay không
với người dùng khác hoặc thay đổi quyền truy cập. |
setSharing(accessType, permissionType) | File | Thiết lập lớp người dùng có thể truy cập vào File và những quyền
những người dùng đó, bên cạnh 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 | Đặt File có nằm trong thùng rác trên 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 | Nhận 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 tập hợp các 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 cụ thể vào danh sách người chỉnh sửa cho Folder. |
addEditor(user) | Folder | Thêm người dùng cụ thể vào danh sách người chỉnh sửa cho Folder. |
addEditors(emailAddresses) | Folder | Thêm mảng người dùng nhất định vào danh sách người chỉnh sửa cho Folder. |
addViewer(emailAddress) | Folder | Thêm người dùng cụ thể vào danh sách người xem cho Folder. |
addViewer(user) | Folder | Thêm người dùng cụ thể vào danh sách người xem cho Folder. |
addViewers(emailAddresses) | Folder | Thêm mảng người dùng nhất định 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 chứa dữ liệu tuỳ ý. |
createFile(name, content) | File | Tạ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) | 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ã mục được cung cấp trên Drive rồi trả về mã đó. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Tạo lối tắt đến mã mục và khoá tài nguyên được cung cấp trên Drive rồi trả về. |
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 | Xem 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 tất cả các tệp là con của thư mục hiện tại. |
getFilesByName(name) | FileIterator | Lấy một tập hợp tất cả các tệp là con của thư mục hiện tại và có tên đã cho. |
getFilesByType(mimeType) | FileIterator | Lấy một tập hợp gồm tất cả các tệp là con của thư mục hiện tại và có loại MIME cho sẵn. |
getFolders() | FolderIterator | Lấy một tập hợp tất cả các thư mục là 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à 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 | Xem ngày gần đây nhất mà Folder được cập nhật. |
getName() | String | Lấy tên của Folder. |
getOwner() | User | Chọn 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 một liên kết. |
getSecurityUpdateEligible() | Boolean | Xem liệu Folder này có đủ điều kiện áp dụng bản cập nhật bảo mật hay không
cần có một khoá tài nguyên để truy cập khi khoá này được chia sẻ bằng đường liên kết. |
getSecurityUpdateEnabled() | Boolean | Tìm hiểu xem 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 liên kết. |
getSharingAccess() | Access | Lấy lớp người dùng có thể truy cập vào Folder, ngoài từng cá nhân
những người dùng đã được cấp quyền truy cập một cách rõ ràng. |
getSharingPermission() | Permission | Được cấp quyền cho những người dùng 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 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[] | 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 Folder có được phép
chia sẻ với người dùng khác hoặc thay đổi quyền truy cập. |
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 trên Drive của người dùng hay không. |
moveTo(destination) | Folder | Chuyển mục này đến thư mục đích được 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 đối với 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 đối với Folder. |
revokePermissions(emailAddress) | Folder | Thu hồi quyền truy cập vào Folder được cấp cho người dùng cụ thể. |
revokePermissions(user) | Folder | Thu hồi quyền truy cập vào Folder được cấp cho người dùng cụ thể. |
searchFiles(params) | FileIterator | Lấy một tập hợp tất cả các tệp là con của thư mục hiện tại và khớp với nội dung tìm kiếm đã cho tiêu chí. |
searchFolders(params) | FolderIterator | Lấy một tập hợp tất cả các thư mục là con của thư mục hiện tại và khớp với nội dung tìm kiếm đã cho tiêu chí. |
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 liên kết. |
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ẻ hay không
với người dùng khác hoặc thay đổi quyền truy cập. |
setSharing(accessType, permissionType) | Folder | Thiết lập lớp người dùng có thể truy cập vào Folder và những quyền
những người dùng đó, bên cạnh 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 | Đặt Folder có nằm trong thùng rác trên 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 | Nhận 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 tập hợp các 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ó 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ó quyền truy cập vào tệp hoặc thư mục đều 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 sẽ 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 các tệp và thư mục trong một 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ó bất kỳ quyền nào đố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 ảnh của người dùng. |