Class DriveApp

DriveApp

Mengizinkan skrip untuk 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

PropertiJenisDeskripsi
AccessAccessEnum yang mewakili class pengguna yang dapat mengakses file atau folder, selain pengguna individu yang telah diberi akses secara eksplisit.
PermissionPermissionEnum yang mewakili izin yang diberikan kepada pengguna yang dapat mengakses file atau folder, selain pengguna individual 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 tertentu.
createFile(name, content)FileMembuat file teks di root Drive pengguna dengan nama dan konten yang diberikan.
createFile(name, content, mimeType)FileMembuat file di root Drive pengguna dengan nama, konten, dan jenis MIME yang diberikan.
createFolder(name)FolderMembuat folder di root Drive pengguna dengan nama yang ditentukan.
createShortcut(targetId)FileMembuat pintasan ke ID item Drive yang diberikan, lalu menampilkannya.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileMembuat pintasan ke ID item Drive dan kunci resource yang disediakan, lalu menampilkannya.
enforceSingleParent(value)voidMengaktifkan atau menonaktifkan perilaku penerapan SingleParent 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 diberikan.
getFiles()FileIteratorMendapatkan kumpulan semua file dalam Drive pengguna.
getFilesByName(name)FileIteratorMendapatkan kumpulan semua file di Drive pengguna yang memiliki nama tertentu.
getFilesByType(mimeType)FileIteratorMendapatkan kumpulan semua file dalam Drive pengguna yang memiliki jenis MIME yang ditentukan.
getFolderById(id)FolderMendapatkan folder dengan ID yang diberikan.
getFolderByIdAndResourceKey(id, resourceKey)FolderMendapatkan folder dengan ID dan kunci resource yang diberikan.
getFolders()FolderIteratorMendapatkan kumpulan semua folder di Drive pengguna.
getFoldersByName(name)FolderIteratorMendapatkan kumpulan 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 pengguna di Drive.
getTrashedFiles()FileIteratorMendapatkan kumpulan semua file dalam sampah Drive pengguna.
getTrashedFolders()FolderIteratorMendapatkan koleksi semua folder di sampah Drive pengguna.
searchFiles(params)FileIteratorMendapatkan kumpulan semua file di Drive pengguna yang cocok dengan kriteria penelusuran yang ditentukan.
searchFolders(params)FolderIteratorMendapatkan kumpulan semua folder di Drive pengguna yang cocok dengan kriteria penelusuran yang ditentukan.

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 lanjutan umumnya valid selama satu minggu.

// Continues getting a list of all 'Untitled document' files in the user's Drive.
// Creates a file iterator named 'previousIterator'.
const previousIterator = DriveApp.getFilesByName('Untitled document');

// Gets continuation token from the previous file iterator.
const continuationToken = previousIterator.getContinuationToken();

// Creates a new iterator using the continuation token from the previous file iterator.
const newIterator = DriveApp.continueFileIterator(continuationToken);

// Resumes the file iteration using a continuation token from 'firstIterator' and
// logs the file name.
if (newIterator.hasNext()) {
  const file = newIterator.next();
  console.log(file.getName());
}

Parameter

NamaJenisDeskripsi
continuationTokenStringToken lanjutan 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 lanjutan umumnya valid selama satu minggu.

// Continues getting a list of all folders in user's Drive.
// Creates a folder iterator named 'previousIterator'.
const previousIterator = DriveApp.getFolders();

// Gets continuation token from the previous folder iterator.
const continuationToken = previousIterator.getContinuationToken();

// Creates a new iterator using the continuation token from the previous folder iterator.
const newIterator = DriveApp.continueFolderIterator(continuationToken);

// Resumes the folder iteration using a continuation token from the previous iterator and logs
// the folder name.
if (newIterator.hasNext()) {
  const folder = newIterator.next();
  console.log(folder.getName());
}

Parameter

NamaJenisDeskripsi
continuationTokenStringToken lanjutan dari iterator folder sebelumnya.

Return

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


createFile(blob)

Membuat file di root Drive pengguna dari Blob data arbitrer tertentu.

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

NamaJenisDeskripsi
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 diberikan. 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

NamaJenisDeskripsi
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 diberikan. 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

NamaJenisDeskripsi
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

NamaJenisDeskripsi
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, lalu menampilkannya.

Parameter

NamaJenisDeskripsi
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.

// Creates shortcuts for all folders in the user's drive that have a specific name.
// TODO(developer): Replace 'Test-Folder' with a valid folder name in your drive.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(folder.getId(), folder.getResourceKey());
}

Parameter

NamaJenisDeskripsi
targetIdStringID file atau folder target.
targetResourceKeyStringKunci resource 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

enforceSingleParent(value)

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

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

// Enables enforceSingleParent behavior for all calls affecting item parents.
DriveApp.enforceSingleParent(true);

Parameter

NamaJenisDeskripsi
valueBooleanStatus baru dari tanda applySingleParent.

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 pembuatan 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

NamaJenisDeskripsi
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 diberikan. Kunci resource adalah parameter tambahan yang harus diteruskan untuk mengakses file yang telah dibagikan menggunakan link.

Menampilkan pengecualian pembuatan 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

NamaJenisDeskripsi
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 kumpulan semua file dalam 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 kumpulan semua file di Drive pengguna yang memiliki nama tertentu.

Parameter

NamaJenisDeskripsi
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 kumpulan semua file dalam Drive pengguna yang memiliki jenis MIME yang ditentukan.

Parameter

NamaJenisDeskripsi
mimeTypeStringJenis file MIME yang akan ditemukan.

Return

FileIterator — Kumpulan semua file dalam Drive pengguna yang memiliki jenis MIME yang ditentukan.

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 pembuatan skrip jika folder tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.

Parameter

NamaJenisDeskripsi
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 pembuatan skrip jika folder tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.

Parameter

NamaJenisDeskripsi
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 kumpulan 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 kumpulan semua folder di Drive pengguna yang memiliki nama tertentu.

Parameter

NamaJenisDeskripsi
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 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 saat ini disimpan 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

getTrashedFiles()

Mendapatkan kumpulan semua file dalam sampah 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 di 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 kumpulan semua file di Drive pengguna yang cocok dengan kriteria penelusuran yang ditentukan. Kriteria penelusuran dijelaskan secara terperinci di dokumentasi SDK Google Drive. Perlu diperhatikan 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 berhati-hatilah agar 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

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

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 kumpulan semua folder di Drive pengguna yang cocok dengan kriteria penelusuran yang ditentukan. Kriteria penelusuran dijelaskan secara terperinci di dokumentasi SDK Google Drive. Perlu diperhatikan 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 berhati-hatilah agar 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

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

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