Drive Service

Drive

Layanan ini memungkinkan skrip membuat, menemukan, dan mengubah file serta folder di Google Drive.

Jika skrip Anda menggunakan project Cloud standar, bukan project Cloud default, Anda harus mengaktifkan Drive API secara manual. Di project Cloud standar, aktifkan Drive API:

Aktifkan Drive API

Contoh kode berikut menunjukkan cara mencatat nama setiap file dalam folder My Drive pengguna:
// 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());
}

Class

NamaDeskripsi singkat
AccessEnum yang mewakili class pengguna yang dapat mengakses file atau folder, selain pengguna individu yang telah diberi akses secara eksplisit.
DriveAppMengizinkan skrip membuat, menemukan, dan mengubah file serta folder di Google Drive.
FileFile di Google Drive.
FileIteratorIterator yang memungkinkan skrip melakukan iterasi pada kumpulan file yang berpotensi besar.
FolderFolder di Google Drive.
FolderIteratorObjek yang memungkinkan skrip melakukan iterasi pada kumpulan folder yang berpotensi besar.
PermissionEnum yang mewakili izin yang diberikan kepada pengguna yang dapat mengakses file atau folder, selain setiap pengguna individu yang telah diberi akses secara eksplisit.
UserPengguna yang terkait dengan file di Google Drive.

Access

Properti

PropertiJenisDeskripsi
ANYONEEnumSiapa saja di Internet dapat menemukan dan mengakses.
ANYONE_WITH_LINKEnumSiapa saja yang memiliki link dapat mengakses.
DOMAINEnumOrang di domain Anda dapat menemukan dan mengakses.
DOMAIN_WITH_LINKEnumOrang di domain Anda yang memiliki link dapat mengakses.
PRIVATEEnumHanya orang yang diberi izin secara tegas yang dapat mengakses.

DriveApp

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 setiap pengguna individu yang telah diberi akses secara eksplisit.

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
continueFileIterator(continuationToken)FileIteratorMelanjutkan iterasi file menggunakan token lanjutan dari iterator sebelumnya.
continueFolderIterator(continuationToken)FolderIteratorMelanjutkan iterasi folder menggunakan token lanjutan 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 diberikan.
createShortcut(targetId)FileMembuat pintasan ke ID item Drive yang disediakan, dan menampilkannya.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileMembuat pintasan ke ID item Drive dan kunci resource yang diberikan, lalu menampilkannya.
enforceSingleParent(value)voidMengaktifkan atau menonaktifkan perilaku enforceSingleParent 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 koleksi semua file di Drive pengguna.
getFilesByName(name)FileIteratorMendapatkan koleksi semua file di Drive pengguna yang memiliki nama yang diberikan.
getFilesByType(mimeType)FileIteratorMendapatkan koleksi semua file di Drive pengguna yang memiliki jenis MIME yang diberikan.
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 yang diberikan.
getRootFolder()FolderMendapatkan folder di root Drive pengguna.
getStorageLimit()IntegerMendapatkan jumlah byte yang diizinkan untuk disimpan pengguna di Drive.
getStorageUsed()IntegerMendapatkan jumlah byte yang saat ini disimpan pengguna di Drive.
getTrashedFiles()FileIteratorMendapatkan kumpulan semua file di sampah Drive pengguna.
getTrashedFolders()FolderIteratorMendapatkan kumpulan semua folder di sampah Drive pengguna.
searchFiles(params)FileIteratorMendapatkan kumpulan semua file di Drive pengguna yang cocok dengan kriteria penelusuran yang diberikan.
searchFolders(params)FolderIteratorMendapatkan kumpulan semua folder di Drive pengguna yang cocok dengan kriteria penelusuran yang diberikan.

File

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addCommenter(emailAddress)FileTambahkan pengguna yang diberikan ke daftar pemberi komentar untuk File.
addCommenter(user)FileTambahkan pengguna yang diberikan ke daftar pemberi komentar untuk File.
addCommenters(emailAddresses)FileTambahkan array pengguna yang diberikan ke daftar pemberi komentar untuk File.
addEditor(emailAddress)FileMenambahkan pengguna tertentu ke daftar editor untuk File.
addEditor(user)FileMenambahkan pengguna tertentu ke daftar editor untuk File.
addEditors(emailAddresses)FileMenambahkan array pengguna yang diberikan ke daftar editor untuk File.
addViewer(emailAddress)FileMenambahkan pengguna yang diberikan ke daftar penonton untuk File.
addViewer(user)FileMenambahkan pengguna yang diberikan ke daftar penonton untuk File.
addViewers(emailAddresses)FileMenambahkan array pengguna yang diberikan ke daftar penonton untuk File.
getAccess(email)PermissionMendapatkan izin yang diberikan kepada pengguna tertentu.
getAccess(user)PermissionMendapatkan izin yang diberikan kepada pengguna tertentu.
getAs(contentType)BlobMenampilkan data di dalam objek ini sebagai blob yang dikonversi ke jenis konten yang ditentukan.
getBlob()BlobMenampilkan data di dalam objek ini sebagai blob.
getDateCreated()DateMendapatkan tanggal pembuatan File.
getDescription()StringMendapatkan deskripsi untuk File.
getDownloadUrl()StringMendapatkan URL yang dapat digunakan untuk mendownload file.
getEditors()User[]Mendapatkan daftar editor untuk File ini.
getId()StringMendapatkan ID File.
getLastUpdated()DateMendapatkan tanggal File terakhir diperbarui.
getMimeType()StringMendapatkan jenis MIME file.
getName()StringMendapatkan nama File.
getOwner()UserMendapatkan pemilik file.
getParents()FolderIteratorMendapatkan kumpulan folder yang merupakan induk langsung File.
getResourceKey()StringMendapatkan kunci resource File yang diperlukan untuk mengakses item yang telah dibagikan menggunakan link.
getSecurityUpdateEligible()BooleanMendapatkan apakah File ini memenuhi syarat untuk menerapkan update keamanan yang memerlukan kunci resource untuk akses saat dibagikan menggunakan link.
getSecurityUpdateEnabled()BooleanMendapatkan apakah File ini memerlukan kunci resource untuk akses saat dibagikan menggunakan link.
getSharingAccess()AccessMendapatkan class pengguna yang dapat mengakses File, selain pengguna individual yang telah diberi akses secara eksplisit.
getSharingPermission()PermissionMendapatkan izin yang diberikan kepada pengguna yang dapat mengakses File, selain pengguna individu yang telah diberi akses secara eksplisit.
getSize()IntegerMendapatkan jumlah byte yang digunakan untuk menyimpan File di Drive.
getTargetId()StringJika ini adalah Pintasan, tampilkan ID item yang ditunjuknya.
getTargetMimeType()StringJika ini adalah Pintasan, tampilkan jenis mime item yang ditunjuknya.
getTargetResourceKey()StringJika file adalah pintasan, menampilkan kunci resource item yang ditunjuknya.
getThumbnail()BlobMendapatkan gambar thumbnail untuk file, atau null jika tidak ada thumbnail.
getUrl()StringMendapatkan URL yang dapat digunakan untuk membuka File di Aplikasi Google seperti Drive atau Dokumen.
getViewers()User[]Mendapatkan daftar pelihat dan pengomentar untuk File ini.
isShareableByEditors()BooleanMenentukan apakah pengguna dengan izin edit ke File diizinkan untuk membagikan dengan pengguna lain atau mengubah izin.
isStarred()BooleanMenentukan apakah File telah diberi bintang di Drive pengguna.
isTrashed()BooleanMenentukan apakah File ada di sampah Drive pengguna.
makeCopy()FileMembuat salinan file.
makeCopy(destination)FileMembuat salinan file di direktori tujuan.
makeCopy(name)FileMembuat salinan file dan memberi nama dengan nama yang diberikan.
makeCopy(name, destination)FileMembuat salinan file di direktori tujuan dan menamainya dengan nama yang diberikan.
moveTo(destination)FileMemindahkan item ini ke folder tujuan yang disediakan.
removeCommenter(emailAddress)FileMenghapus pengguna tertentu dari daftar pemberi komentar untuk File.
removeCommenter(user)FileMenghapus pengguna tertentu dari daftar pemberi komentar untuk File.
removeEditor(emailAddress)FileMenghapus pengguna tertentu dari daftar editor untuk File.
removeEditor(user)FileMenghapus pengguna tertentu dari daftar editor untuk File.
removeViewer(emailAddress)FileMenghapus pengguna tertentu dari daftar penonton dan pemberi komentar untuk File.
removeViewer(user)FileMenghapus pengguna tertentu dari daftar penonton dan pemberi komentar untuk File.
revokePermissions(emailAddress)FileMembatalkan akses ke File yang diberikan kepada pengguna tertentu.
revokePermissions(user)FileMembatalkan akses ke File yang diberikan kepada pengguna tertentu.
setContent(content)FileMenimpa konten file dengan penggantian tertentu.
setDescription(description)FileMenetapkan deskripsi untuk File.
setName(name)FileMenetapkan nama File.
setOwner(emailAddress)FileMengubah pemilik File.
setOwner(user)FileMengubah pemilik File.
setSecurityUpdateEnabled(enabled)FileMenetapkan apakah File memerlukan kunci resource untuk akses saat dibagikan menggunakan link.
setShareableByEditors(shareable)FileMenetapkan apakah pengguna dengan izin edit ke File diizinkan untuk berbagi dengan pengguna lain atau mengubah izin.
setSharing(accessType, permissionType)FileMenetapkan class pengguna yang dapat mengakses File dan izin yang diberikan kepada pengguna tersebut, selain pengguna individu yang telah diberi akses secara eksplisit.
setStarred(starred)FileMenetapkan apakah File diberi bintang di Drive pengguna.
setTrashed(trashed)FileMenetapkan apakah File ada di sampah Drive pengguna.

FileIterator

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getContinuationToken()StringMendapatkan token yang dapat digunakan untuk melanjutkan iterasi ini di lain waktu.
hasNext()BooleanMenentukan apakah memanggil next() akan menampilkan item.
next()FileMendapatkan item berikutnya dalam kumpulan file atau folder.

Folder

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addEditor(emailAddress)FolderMenambahkan pengguna tertentu ke daftar editor untuk Folder.
addEditor(user)FolderMenambahkan pengguna tertentu ke daftar editor untuk Folder.
addEditors(emailAddresses)FolderMenambahkan array pengguna yang diberikan ke daftar editor untuk Folder.
addViewer(emailAddress)FolderMenambahkan pengguna yang diberikan ke daftar penonton untuk Folder.
addViewer(user)FolderMenambahkan pengguna yang diberikan ke daftar penonton untuk Folder.
addViewers(emailAddresses)FolderMenambahkan array pengguna yang diberikan ke daftar penonton untuk Folder.
createFile(blob)FileMembuat file di folder saat ini dari Blob data arbitrer tertentu.
createFile(name, content)FileMembuat file teks di folder saat ini dengan nama dan konten yang diberikan.
createFile(name, content, mimeType)FileMembuat file di folder saat ini dengan nama, konten, dan jenis MIME yang diberikan.
createFolder(name)FolderMembuat folder di folder saat ini dengan nama yang diberikan.
createShortcut(targetId)FileMembuat pintasan ke ID item Drive yang disediakan, dan menampilkannya.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileMembuat pintasan ke ID item Drive dan kunci resource yang diberikan, lalu menampilkannya.
getAccess(email)PermissionMendapatkan izin yang diberikan kepada pengguna tertentu.
getAccess(user)PermissionMendapatkan izin yang diberikan kepada pengguna tertentu.
getDateCreated()DateMendapatkan tanggal pembuatan Folder.
getDescription()StringMendapatkan deskripsi untuk Folder.
getEditors()User[]Mendapatkan daftar editor untuk Folder ini.
getFiles()FileIteratorMendapatkan kumpulan semua file yang merupakan turunan dari folder saat ini.
getFilesByName(name)FileIteratorMendapatkan kumpulan semua file yang merupakan turunan dari folder saat ini dan memiliki nama yang diberikan.
getFilesByType(mimeType)FileIteratorMendapatkan kumpulan semua file yang merupakan turunan dari folder saat ini dan memiliki jenis MIME yang diberikan.
getFolders()FolderIteratorMendapatkan kumpulan semua folder yang merupakan turunan dari folder saat ini.
getFoldersByName(name)FolderIteratorMendapatkan kumpulan semua folder yang merupakan turunan dari folder saat ini dan memiliki nama yang diberikan.
getId()StringMendapatkan ID Folder.
getLastUpdated()DateMendapatkan tanggal Folder terakhir diperbarui.
getName()StringMendapatkan nama Folder.
getOwner()UserMendapatkan pemilik Folder ini.
getParents()FolderIteratorMendapatkan kumpulan folder yang merupakan induk langsung Folder.
getResourceKey()StringMendapatkan kunci resource Folder yang diperlukan untuk mengakses item yang telah dibagikan menggunakan link.
getSecurityUpdateEligible()BooleanMendapatkan apakah Folder ini memenuhi syarat untuk menerapkan update keamanan yang memerlukan kunci resource untuk akses saat dibagikan menggunakan link.
getSecurityUpdateEnabled()BooleanMendapatkan apakah Folder ini memerlukan kunci resource untuk akses saat dibagikan menggunakan link.
getSharingAccess()AccessMendapatkan class pengguna yang dapat mengakses Folder, selain pengguna individual yang telah diberi akses secara eksplisit.
getSharingPermission()PermissionMendapatkan izin yang diberikan kepada pengguna yang dapat mengakses Folder, selain pengguna individu yang telah diberi akses secara eksplisit.
getSize()IntegerMendapatkan jumlah byte yang digunakan untuk menyimpan Folder di Drive.
getUrl()StringMendapatkan URL yang dapat digunakan untuk membuka Folder di Aplikasi Google seperti Drive atau Dokumen.
getViewers()User[]Mendapatkan daftar pelihat dan pengomentar untuk Folder ini.
isShareableByEditors()BooleanMenentukan apakah pengguna dengan izin edit ke Folder diizinkan untuk membagikan dengan pengguna lain atau mengubah izin.
isStarred()BooleanMenentukan apakah Folder telah diberi bintang di Drive pengguna.
isTrashed()BooleanMenentukan apakah Folder ada di sampah Drive pengguna.
moveTo(destination)FolderMemindahkan item ini ke folder tujuan yang disediakan.
removeEditor(emailAddress)FolderMenghapus pengguna tertentu dari daftar editor untuk Folder.
removeEditor(user)FolderMenghapus pengguna tertentu dari daftar editor untuk Folder.
removeViewer(emailAddress)FolderMenghapus pengguna tertentu dari daftar penonton dan pemberi komentar untuk Folder.
removeViewer(user)FolderMenghapus pengguna tertentu dari daftar penonton dan pemberi komentar untuk Folder.
revokePermissions(emailAddress)FolderMembatalkan akses ke Folder yang diberikan kepada pengguna tertentu.
revokePermissions(user)FolderMembatalkan akses ke Folder yang diberikan kepada pengguna tertentu.
searchFiles(params)FileIteratorMendapatkan kumpulan semua file yang merupakan turunan dari folder saat ini dan cocok dengan kriteria penelusuran yang diberikan.
searchFolders(params)FolderIteratorMendapatkan kumpulan semua folder yang merupakan turunan dari folder saat ini dan cocok dengan kriteria penelusuran yang diberikan.
setDescription(description)FolderMenetapkan deskripsi untuk Folder.
setName(name)FolderMenetapkan nama Folder.
setOwner(emailAddress)FolderMengubah pemilik Folder.
setOwner(user)FolderMengubah pemilik Folder.
setSecurityUpdateEnabled(enabled)FolderMenetapkan apakah Folder memerlukan kunci resource untuk akses saat dibagikan menggunakan link.
setShareableByEditors(shareable)FolderMenetapkan apakah pengguna dengan izin edit ke Folder diizinkan untuk berbagi dengan pengguna lain atau mengubah izin.
setSharing(accessType, permissionType)FolderMenetapkan class pengguna yang dapat mengakses Folder dan izin yang diberikan kepada pengguna tersebut, selain pengguna individu yang telah diberi akses secara eksplisit.
setStarred(starred)FolderMenetapkan apakah Folder diberi bintang di Drive pengguna.
setTrashed(trashed)FolderMenetapkan apakah Folder ada di sampah Drive pengguna.

FolderIterator

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getContinuationToken()StringMendapatkan token yang dapat digunakan untuk melanjutkan iterasi ini di lain waktu.
hasNext()BooleanMenentukan apakah memanggil next() akan menampilkan item.
next()FolderMendapatkan item berikutnya dalam kumpulan file atau folder.

Permission

Properti

PropertiJenisDeskripsi
VIEWEnumPengguna yang dapat mengakses file atau folder hanya dapat melihat atau menyalinnya.
EDITEnumPengguna yang dapat mengakses file atau folder dapat mengeditnya.
COMMENTEnumPengguna yang dapat mengakses file atau folder hanya dapat melihat, menyalin, atau memberi komentar pada file atau folder tersebut.
OWNEREnumPengguna memiliki file atau folder tersebut.
ORGANIZEREnumPengguna yang dapat mengatur file dan folder dalam drive bersama.
FILE_ORGANIZEREnumPengguna yang dapat mengedit, menghapus, dan memindahkan konten dalam drive bersama.
NONEEnumPengguna tidak memiliki izin apa pun untuk file atau folder.

User

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getDomain()StringMendapatkan nama domain yang terkait dengan akun pengguna.
getEmail()StringMendapatkan alamat email pengguna.
getName()StringMendapatkan nama pengguna.
getPhotoUrl()StringMendapatkan URL untuk foto pengguna.