Class DriveApp

Aplikasi Drive

Memungkinkan skrip membuat, menemukan, dan mengubah file serta folder di Google Drive. Untuk mengakses file atau folder di drive bersama, gunakan layanan Drive lanjutan.

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

Properti

PropertiTypeDeskripsi
AccessAccessEnum yang mewakili class pengguna yang dapat mengakses file atau folder, selain setiap pengguna yang telah diberi akses secara eksplisit.
PermissionPermissionEnum yang mewakili izin yang diberikan kepada pengguna yang dapat mengakses file atau folder, selain setiap pengguna yang telah diberi akses secara eksplisit.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
continueFileIterator(continuationToken)FileIteratorMelanjutkan iterasi file menggunakan token kelanjutan dari iterator sebelumnya.
continueFolderIterator(continuationToken)FolderIteratorMelanjutkan iterasi folder menggunakan token kelanjutan dari iterator sebelumnya.
createFile(blob)FileMembuat file di root Drive pengguna dari Blob data arbitrer yang diberikan.
createFile(name, content)FileMembuat file teks di root Drive pengguna dengan nama dan konten yang ditentukan.
createFile(name, content, mimeType)FileMembuat file di root Drive pengguna dengan nama, konten, dan jenis MIME yang ditentukan.
createFolder(name)FolderMembuat folder di root Drive pengguna dengan nama yang ditentukan.
createShortcut(targetId)FileMembuat pintasan ke ID item Drive yang diberikan, dan menampilkannya.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileMembuat pintasan ke ID item Drive dan kunci resource yang disediakan, lalu menampilkannya.
enforceSingleParent(value)voidMengaktifkan atau menonaktifkan perilaku applySingleParent untuk semua panggilan yang memengaruhi induk item.
getFileById(id)FileMendapatkan file dengan ID yang diberikan.
getFileByIdAndResourceKey(id, resourceKey)FileMendapatkan file dengan ID dan kunci resource yang ditentukan.
getFiles()FileIteratorMendapatkan koleksi semua file di Drive pengguna.
getFilesByName(name)FileIteratorMendapatkan koleksi semua file di Drive pengguna yang memiliki nama tertentu.
getFilesByType(mimeType)FileIteratorMendapatkan koleksi semua file di Drive pengguna yang memiliki jenis MIME tertentu.
getFolderById(id)FolderMendapatkan folder dengan ID yang diberikan.
getFolderByIdAndResourceKey(id, resourceKey)FolderMendapatkan folder dengan ID dan kunci resource yang diberikan.
getFolders()FolderIteratorMendapatkan koleksi semua folder di Drive pengguna.
getFoldersByName(name)FolderIteratorMendapatkan koleksi semua folder di Drive pengguna yang memiliki nama tertentu.
getRootFolder()FolderMendapatkan folder di root Drive pengguna.
getStorageLimit()IntegerMendapatkan jumlah byte yang diizinkan untuk disimpan oleh pengguna di Drive.
getStorageUsed()IntegerMendapatkan jumlah byte yang saat ini disimpan oleh pengguna di Drive.
getTrashedFiles()FileIteratorMendapatkan koleksi semua file dalam sampah di Drive pengguna.
getTrashedFolders()FolderIteratorMendapatkan koleksi semua folder dalam sampah Drive pengguna.
searchFiles(params)FileIteratorMendapatkan koleksi semua file di Drive pengguna yang cocok dengan kriteria penelusuran tertentu.
searchFolders(params)FolderIteratorMendapatkan koleksi semua folder di Drive pengguna yang cocok dengan kriteria penelusuran tertentu.

Dokumentasi mendetail

continueFileIterator(continuationToken)

Melanjutkan iterasi file menggunakan token kelanjutan dari iterator sebelumnya. Metode ini berguna jika pemrosesan iterator dalam satu eksekusi melebihi waktu eksekusi maksimum. Token kelanjutan umumnya valid selama satu minggu.

Parameter

NamaTypeDeskripsi
continuationTokenStringToken kelanjutan dari iterator file sebelumnya.

Return

FileIterator — Kumpulan file yang tetap ada di iterator sebelumnya saat token kelanjutan dibuat.


continueFolderIterator(continuationToken)

Melanjutkan iterasi folder menggunakan token kelanjutan dari iterator sebelumnya. Metode ini berguna jika pemrosesan iterator dalam satu eksekusi melebihi waktu eksekusi maksimum. Token kelanjutan umumnya valid selama satu minggu.

Parameter

NamaTypeDeskripsi
continuationTokenStringToken kelanjutan dari iterator folder sebelumnya.

Return

FolderIterator — Kumpulan folder yang tetap ada di iterator sebelumnya saat token kelanjutan dibuat.


createFile(blob)

Membuat file di root Drive pengguna dari Blob data arbitrer yang diberikan.

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

Parameter

NamaTypeDeskripsi
blobBlobSourceData untuk file baru.

Return

File — File baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

createFile(name, content)

Membuat file teks di root Drive pengguna dengan nama dan konten yang ditentukan. Menampilkan pengecualian jika content lebih besar dari 50 MB.

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

Parameter

NamaTypeDeskripsi
nameStringNama file baru.
contentStringKonten untuk file baru.

Return

File — File baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

createFile(name, content, mimeType)

Membuat file di root Drive pengguna dengan nama, konten, dan jenis MIME yang ditentukan. Menampilkan pengecualian jika content lebih besar dari 10 MB.

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

Parameter

NamaTypeDeskripsi
nameStringNama file baru.
contentStringKonten untuk file baru.
mimeTypeStringJenis MIME dari file baru.

Return

File — File baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

createFolder(name)

Membuat folder di root Drive pengguna dengan nama yang ditentukan.

Parameter

NamaTypeDeskripsi
nameStringNama folder baru.

Return

Folder — Folder baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

createShortcut(targetId)

Membuat pintasan ke ID item Drive yang diberikan, dan menampilkannya.

Parameter

NamaTypeDeskripsi
targetIdStringID file dari file atau folder target.

Return

File — Pintasan baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Membuat pintasan ke ID item Drive dan kunci resource yang disediakan, lalu menampilkannya. Kunci resource adalah parameter tambahan yang harus diteruskan untuk mengakses file atau folder target yang telah dibagikan menggunakan link.

Parameter

NamaTypeDeskripsi
targetIdStringID file atau folder target.
targetResourceKeyStringKunci resource file atau folder target.

Return

File — Pintasan baru.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

enforceSingleParent(value)

Mengaktifkan atau menonaktifkan perilaku applySingleParent untuk semua panggilan yang memengaruhi induk item.

Lihat blog Menyederhanakan struktur folder dan model berbagi Google Drive untuk detail selengkapnya.

Parameter

NamaTypeDeskripsi
valueBooleanStatus baru flag deploySingleParent.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getFileById(id)

Mendapatkan file dengan ID yang diberikan. Menampilkan pengecualian skrip jika file tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace 'Test' with your file name.
const files = DriveApp.getFilesByName('Test');

if (files.hasNext()) {
  // Gets the ID of each file in the list.
  const fileId = files.next().getId();

  // Gets the file name using its ID and logs it to the console.
  console.log(DriveApp.getFileById(fileId).getName());
}

Parameter

NamaTypeDeskripsi
idStringID file.

Return

File — File dengan ID yang diberikan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getFileByIdAndResourceKey(id, resourceKey)

Mendapatkan file dengan ID dan kunci resource yang ditentukan. Kunci resource adalah parameter tambahan yang harus diteruskan untuk mengakses file yang telah dibagikan menggunakan link.

Menampilkan pengecualian skrip jika file tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.

// Gets a list of all files in Drive with the given name.
// TODO(developer): Replace 'Test' with your file name.
const files = DriveApp.getFilesByName('Test');
if (files.hasNext()) {

  // Gets the first file in the list.
  const file = files.next();

  // Gets the ID and resource key.
  const key = file.getResourceKey();
  const id = file.getId();

  // Logs the file name to the console using its ID and resource key.
  console.log(DriveApp.getFileByIdAndResourceKey(id, key).getName());
}

Parameter

NamaTypeDeskripsi
idStringID file.
resourceKeyStringKunci resource folder.

Return

File — File dengan ID yang diberikan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getFiles()

Mendapatkan koleksi semua file di Drive pengguna.

Return

FileIterator — Kumpulan semua file di Drive pengguna.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getFilesByName(name)

Mendapatkan koleksi semua file di Drive pengguna yang memiliki nama tertentu.

Parameter

NamaTypeDeskripsi
nameStringNama file yang akan ditemukan.

Return

FileIterator — Kumpulan semua file di Drive pengguna yang memiliki nama tertentu.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getFilesByType(mimeType)

Mendapatkan koleksi semua file di Drive pengguna yang memiliki jenis MIME tertentu.

Parameter

NamaTypeDeskripsi
mimeTypeStringJenis file MIME yang akan ditemukan.

Return

FileIterator — Kumpulan semua file di Drive pengguna yang memiliki jenis MIME tertentu.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getFolderById(id)

Mendapatkan folder dengan ID yang diberikan. Menampilkan pengecualian skrip jika folder tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.

Parameter

NamaTypeDeskripsi
idStringID folder.

Return

Folder — Folder dengan ID yang diberikan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getFolderByIdAndResourceKey(id, resourceKey)

Mendapatkan folder dengan ID dan kunci resource yang diberikan. Kunci resource adalah parameter tambahan yang harus diteruskan untuk mengakses folder yang telah dibagikan menggunakan link.

Menampilkan pengecualian skrip jika folder tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.

Parameter

NamaTypeDeskripsi
idStringID folder.
resourceKeyStringKunci resource folder.

Return

Folder — Folder dengan ID yang diberikan.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getFolders()

Mendapatkan koleksi semua folder di Drive pengguna.

Return

FolderIterator — Kumpulan semua folder di Drive pengguna.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getFoldersByName(name)

Mendapatkan koleksi semua folder di Drive pengguna yang memiliki nama tertentu.

Parameter

NamaTypeDeskripsi
nameStringNama folder yang akan ditemukan.

Return

FolderIterator — Kumpulan semua folder di Drive pengguna yang memiliki nama tertentu.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getRootFolder()

Mendapatkan folder di root Drive pengguna.

// Gets the user's My Drive folder and logs its name to the console.
console.log(DriveApp.getRootFolder().getName());

// Logs the Drive owner's name to the console.
console.log(DriveApp.getRootFolder().getOwner().getName());

Return

Folder — Folder root Drive pengguna.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getStorageLimit()

Mendapatkan jumlah byte yang diizinkan untuk disimpan oleh pengguna di Drive.

// Gets the number of bytes the user can store in Drive and logs it to the console.
console.log(DriveApp.getStorageLimit());

Return

Integer — Jumlah byte yang diizinkan untuk disimpan oleh pengguna di Drive.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getStorageUsed()

Mendapatkan jumlah byte yang saat ini disimpan oleh pengguna di Drive.

// Gets the number of bytes the user is currently storing in Drive and logs it to the console.
console.log(DriveApp.getStorageUsed());

Return

Integer — Jumlah byte yang disimpan pengguna saat ini di Drive.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getTrashedFiles()

Mendapatkan koleksi semua file dalam sampah di Drive pengguna.

// Gets a list of all the files in the trash of the user's Drive.
const trashFiles = DriveApp.getTrashedFiles();

// Logs the trash file names to the console.
while (trashFiles.hasNext()) {
  const file = trashFiles.next();
  console.log(file.getName());
}

Return

FileIterator — Kumpulan file di sampah.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getTrashedFolders()

Mendapatkan koleksi semua folder dalam sampah Drive pengguna.

// Gets a collection of all the folders in the trash of the user's Drive.
const trashFolders = DriveApp.getTrashedFolders();

// Logs the trash folder names to the console.
while (trashFolders.hasNext()) {
  const folder = trashFolders.next();
  console.log(folder.getName());
}

Return

FolderIterator — Kumpulan folder di sampah.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

searchFiles(params)

Mendapatkan koleksi semua file di Drive pengguna yang cocok dengan kriteria penelusuran tertentu. Kriteria penelusuran diuraikan dalam dokumentasi SDK Google Drive. Perhatikan bahwa layanan Drive menggunakan Drive API v2 dan beberapa kolom kueri berbeda dengan v3. Tinjau perbedaan kolom antara v2 dan v3.

Argumen params adalah string kueri yang dapat berisi nilai string. Jadi, pastikan untuk meng-escape tanda kutip dengan benar (misalnya "title contains 'Gulliver\\'s Travels'" atau 'title contains "Gulliver\'s Travels"').

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

Parameter

NamaTypeDeskripsi
paramsStringKriteria penelusuran, seperti yang dijelaskan dalam dokumentasi Google Drive SDK.

Return

FileIterator — Kumpulan semua file di Drive pengguna yang cocok dengan kriteria penelusuran.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

searchFolders(params)

Mendapatkan koleksi semua folder di Drive pengguna yang cocok dengan kriteria penelusuran tertentu. Kriteria penelusuran diuraikan dalam dokumentasi SDK Google Drive. Perhatikan bahwa layanan Drive menggunakan Drive API v2 dan beberapa kolom kueri berbeda dengan v3. Tinjau perbedaan kolom antara v2 dan v3.

Argumen params adalah string kueri yang dapat berisi nilai string. Jadi, pastikan untuk meng-escape tanda kutip dengan benar (misalnya "title contains 'Gulliver\\'s Travels'" atau 'title contains "Gulliver\'s Travels"').

// Logs 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();
  console.log(folder.getName());
}

Parameter

NamaTypeDeskripsi
paramsStringKriteria penelusuran, seperti yang dijelaskan dalam dokumentasi Google Drive SDK.

Return

FolderIterator — Kumpulan semua folder di Drive pengguna yang cocok dengan kriteria penelusuran.

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

Metode yang tidak digunakan lagi