Class DriveApp

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.

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

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.

Tài liệu chi tiết

continueFileIterator(continuationToken)

Tiế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 đó. Phương thức này hữu ích nếu việc xử lý một biến lặp trong một lượt thực thi vượt quá thời gian thực thi tối đa. Mã thông báo tiếp tục thường có hiệu lực trong một tuần.

Các tham số

TênLoạiMô tả
continuationTokenStringmột mã thông báo tiếp tục từ biến lặp tệp trước đó

Hai chiều

FileIterator – một tập hợp các tệp vẫn nằm trong một trình lặp trước đó khi mã thông báo tiếp tục được tạo


continueFolderIterator(continuationToken)

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ừ biến lặp trước đó. Phương thức này hữu ích nếu việc xử lý một biến lặp trong một lượt thực thi vượt quá thời gian thực thi tối đa. Mã thông báo tiếp tục thường có hiệu lực trong một tuần.

Các tham số

TênLoạiMô tả
continuationTokenStringmã thông báo tiếp tục từ biến lặp thư mục trước đó

Hai chiều

FolderIterator – một tập hợp thư mục vẫn nằm trong một đối tượng iterator trước đó khi mã thông báo tiếp tục được tạo


createFile(blob)

Tạ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 ý.

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.createFile(blob);

Các tham số

TênLoạiMô tả
blobBlobSourceDữ liệu cho tệp mới.

Hai chiều

File – Tệp mới.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive

createFile(name, content)

Tạ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. Khai báo trường hợp ngoại lệ nếu content lớn hơn 50 MB.

// Create a text file with the content "Hello, world!"
DriveApp.createFile('New Text File', 'Hello, world!');

Các tham số

TênLoạiMô tả
nameStringTên của tệp mới.
contentStringNội dung của tệp mới.

Hai chiều

File – Tệp mới.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive

createFile(name, content, mimeType)

Tạo một tệp trong Drive của người dùng có tên, nội dung và loại MIME đã cho. Khai báo ngoại lệ nếu content lớn hơn 10 MB.

// Create an HTML file with the content "Hello, world!"
DriveApp.createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

Các tham số

TênLoạiMô tả
nameStringTên của tệp mới.
contentStringNội dung của tệp mới.
mimeTypeStringLoại MIME của tệp mới.

Hai chiều

File – Tệp mới.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive

createFolder(name)

Tạo một thư mục trong gốc của Drive của người dùng có tên đã cho.

Các tham số

TênLoạiMô tả
nameStringTên của thư mục mới.

Hai chiều

Folder – Thư mục mới.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive

createShortcut(targetId)

Tạo lối tắt đến mã mục trên Drive đã cung cấp và trả lại mã đó.

Các tham số

TênLoạiMô tả
targetIdStringMã tệp của tệp hoặc thư mục đích.

Hai chiều

File — Phím tắt mới.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Tạo một lối tắt đến mã mục và tài nguyên Drive được cung cấp, sau đó trả về. Khoá tài nguyên là một tham số bổ sung cần được truyền để truy cập vào tệp hoặc thư mục đã được chia sẻ bằng đường liên kết.

Các tham số

TênLoạiMô tả
targetIdStringMã của tệp đích hoặc thư mục.
targetResourceKeyStringKhóa tài nguyên của tệp hoặc thư mục đích.

Hai chiều

File — Phím tắt mới.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive

enforceSingleParent(value)

Bậ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ẹ.

Hãy xem blog Đơn giản hoá cấu trúc thư mục của Google Drive và mô hình chia sẻ để biết thêm chi tiết.

Các tham số

TênLoạiMô tả
valueBooleanTrạng thái mới của cờ triển khai SingleSingle.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive

getFileById(id)

Lấy tệp có ID đã cho. Tạo ngoại lệ cho tập lệnh nếu tệp không tồn tại hoặc người dùng không có quyền truy cập tệp.

Các tham số

TênLoạiMô tả
idStringmã nhận dạng của tệp

Hai chiều

File – tệp có mã nhận dạng nhất định

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFileByIdAndResourceKey(id, resourceKey)

Lấy tệp có mã nhận dạng và khoá tài nguyên nhất định. Khoá tài nguyên là một thông số bổ sung cần được truyền cho các tệp truy cập đã được chia sẻ bằng đường liên kết.

Gửi ngoại lệ tập lệnh nếu tệp không tồn tại hoặc người dùng không có quyền truy cập tệp.

Các tham số

TênLoạiMô tả
idStringMã nhận dạng của tệp.
resourceKeyStringKhoá tài nguyên của thư mục.

Hai chiều

File – Tệp có mã nhận dạng nhất định.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFiles()

Lấy tập hợp tất cả tệp trong Drive của người dùng.

Hai chiều

FileIterator — Tập hợp tất cả các tệp trong Drive của người dùng.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFilesByName(name)

Lấy tập hợp tất cả tệp trong Drive của người dùng có tên đã cho.

Các tham số

TênLoạiMô tả
nameStringTên của tệp cần tìm.

Hai chiều

FileIterator — Tập hợp tất cả các tệp trong Drive của người dùng có tên đã cho.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFilesByType(mimeType)

Lấy tập hợp tất cả tệp trong Drive của người dùng có loại MIME đã cho.

Các tham số

TênLoạiMô tả
mimeTypeStringLoại MIME của tệp cần tìm.

Hai chiều

FileIterator – Tập hợp tất cả các tệp trong Drive của người dùng có loại MIME đã cho.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFolderById(id)

Lấy thư mục có mã nhận dạng đã cho. Tạo ngoại lệ cho tập lệnh nếu thư mục không tồn tại hoặc người dùng không có quyền truy cập vào tập lệnh đó.

Các tham số

TênLoạiMô tả
idStringmã nhận dạng của thư mục

Hai chiều

Folder – thư mục có mã nhận dạng đã cho

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFolderByIdAndResourceKey(id, resourceKey)

Lấy thư mục có mã nhận dạng và khoá tài nguyên nhất định. Khoá tài nguyên là một thông số bổ sung cần được chuyển sang các thư mục truy cập đã được chia sẻ bằng một đường liên kết.

Gửi ngoại lệ tập lệnh nếu thư mục không tồn tại hoặc người dùng không có quyền truy cập vào tập lệnh đó.

Các tham số

TênLoạiMô tả
idStringMã của thư mục.
resourceKeyStringKhoá tài nguyên của thư mục.

Hai chiều

Folder – Thư mục có mã nhận dạng đã cho.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFolders()

Lấy tập hợp tất cả thư mục trong Drive của người dùng.

Hai chiều

FolderIterator — Tập hợp tất cả các thư mục trong Drive của người dùng.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFoldersByName(name)

Lấ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.

Các tham số

TênLoạiMô tả
nameStringTên của các thư mục cần tìm.

Hai chiều

FolderIterator – Tập hợp tất cả các thư mục trong Drive của người dùng có tên đã cho.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getRootFolder()

Lấy thư mục ở gốc thư mục Drive của người dùng.

Hai chiều

Folder — thư mục gốc của Drive của người dùng

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getStorageLimit()

Lấy số byte người dùng được phép lưu trữ trong Drive.

Hai chiều

Integer – số byte mà người dùng được phép lưu trữ trong Drive

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getStorageUsed()

Lấy số byte người dùng hiện đang lưu trữ trong Drive.

Hai chiều

Integer – số byte mà người dùng hiện đang lưu trữ trong Drive

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getTrashedFiles()

Nhậ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.

Hai chiều

FileIterator — một tập hợp các tệp trong thùng rác

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getTrashedFolders()

Nhậ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.

Hai chiều

FolderIterator — một tập hợp các thư mục trong thùng rác

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

searchFiles(params)

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. Tiêu chí tìm kiếm được nêu chi tiết trong tài liệu về SDK Google Drive. Xin lưu ý rằng đối số params là một chuỗi truy vấn có thể chứa các giá trị chuỗi. Vì vậy, hãy chú ý thoát khỏi các dấu ngoặc kép đúng (ví dụ: "title contains 'Gulliver\\'s Travels'" hoặc 'title contains "Gulliver\'s Travels"').

// Log the name of every file in the user's Drive that modified after February 28,
// 2013 whose name contains "untitled".
var files = DriveApp.searchFiles(
    'modifiedDate > "2013-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

Các tham số

TênLoạiMô tả
paramsStringTiêu chí tìm kiếm, như được nêu chi tiết trong tài liệu về SDK Google Drive.

Hai chiều

FileIterator – Tập hợp tất cả các tệp trong Drive của người dùng phù hợp với tiêu chí tìm kiếm.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

searchFolders(params)

Lấ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. Tiêu chí tìm kiếm được nêu chi tiết trong tài liệu về SDK Google Drive. Xin lưu ý rằng đối số params là một chuỗi truy vấn có thể chứa các giá trị chuỗi. Vì vậy, hãy chú ý thoát khỏi các dấu ngoặc kép đúng (ví dụ: "title contains 'Gulliver\\'s Travels'" hoặc 'title contains "Gulliver\'s Travels"').

// Log the name of every folder in the user's Drive that you own and is starred.
var folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.log(folder.getName());
}

Các tham số

TênLoạiMô tả
paramsStringTiêu chí tìm kiếm, như được nêu chi tiết trong tài liệu về SDK Google Drive.

Hai chiều

FolderIterator – Tập hợp tất cả các thư mục trong Drive của người dùng phù hợp với tiêu chí tìm kiếm.

Ủy quyền

Các tập lệnh sử dụng phương pháp này yêu cầu uỷ quyền bằng một hoặc nhiều phạm vi sau:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

Các phương thức ngừng hoạt động