Class Folder

Video

Folder di Google Drive. Folder dapat diakses atau dibuat dari DriveApp.

// Log the name of every folder in the user's Drive.
var folders = DriveApp.getFolders();
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.log(folder.getName());
}

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 tertentu ke daftar editor untuk Folder.
addViewer(emailAddress)FolderMenambahkan pengguna tertentu ke daftar pelihat untuk Folder.
addViewer(user)FolderMenambahkan pengguna tertentu ke daftar pelihat untuk Folder.
addViewers(emailAddresses)FolderMenambahkan array pengguna tertentu ke daftar pelihat untuk Folder.
createFile(blob)FileMembuat file dalam 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 dalam 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 diberikan, lalu menampilkannya.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileMembuat pintasan ke ID item Drive dan kunci resource yang disediakan, lalu menampilkannya.
getAccess(email)PermissionMendapatkan izin yang diberikan kepada pengguna tertentu.
getAccess(user)PermissionMendapatkan izin yang diberikan kepada pengguna tertentu.
getDateCreated()DateMendapatkan tanggal Folder dibuat.
getDescription()StringMendapatkan deskripsi untuk Folder.
getEditors()User[]Mendapatkan daftar editor untuk Folder ini.
getFiles()FileIteratorMendapatkan koleksi 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 tertentu.
getFilesByType(mimeType)FileIteratorMendapatkan kumpulan semua file yang merupakan turunan dari folder saat ini dan memiliki jenis MIME yang ditentukan.
getFolders()FolderIteratorMendapatkan koleksi semua folder yang merupakan turunan dari folder saat ini.
getFoldersByName(name)FolderIteratorMendapatkan koleksi semua folder yang merupakan turunan dari folder saat ini dan memiliki nama tertentu.
getId()StringMendapatkan ID Folder.
getLastUpdated()DateMendapatkan tanggal Folder terakhir diperbarui.
getName()StringMendapatkan nama Folder.
getOwner()UserMendapatkan pemilik Folder ini.
getParents()FolderIteratorMendapatkan koleksi folder yang merupakan induk langsung dari 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 individu mana pun yang telah diberi akses secara eksplisit.
getSharingPermission()PermissionMendapatkan izin yang diberikan kepada pengguna yang dapat mengakses Folder, selain setiap pengguna 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 berbagi 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 diberikan.
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 pelihat dan pengomentar untuk Folder.
removeViewer(user)FolderMenghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Folder.
revokePermissions(emailAddress)FolderMencabut akses ke Folder yang diberikan kepada pengguna tertentu.
revokePermissions(user)FolderMencabut 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 ditentukan.
searchFolders(params)FolderIteratorMendapatkan kumpulan semua folder yang merupakan turunan dari folder saat ini dan cocok dengan kriteria penelusuran yang ditentukan.
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 setiap pengguna yang telah diberi akses secara eksplisit.
setStarred(starred)FolderMenetapkan apakah Folder dibintangi di Drive pengguna.
setTrashed(trashed)FolderMenetapkan apakah Folder berada di sampah Drive pengguna.

Dokumentasi mendetail

addEditor(emailAddress)

Menambahkan pengguna tertentu ke daftar editor untuk Folder. Jika pengguna sudah ada di daftar audiens, metode ini akan mempromosikan pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

addEditor(user)

Menambahkan pengguna tertentu ke daftar editor untuk Folder. Jika pengguna sudah ada di daftar audiens, metode ini akan mempromosikan pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

addEditors(emailAddresses)

Menambahkan array pengguna tertentu ke daftar editor untuk Folder. Jika salah satu pengguna sudah ada dalam daftar audiens, metode ini akan mempromosikannya dari daftar pelihat.

Parameter

NamaJenisDeskripsi
emailAddressesString[]Array alamat email pengguna yang akan ditambahkan.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

addViewer(emailAddress)

Menambahkan pengguna tertentu ke daftar pelihat untuk Folder. Jika pengguna sudah ada di daftar editor, metode ini tidak akan berpengaruh.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

addViewer(user)

Menambahkan pengguna tertentu ke daftar pelihat untuk Folder. Jika pengguna sudah ada di daftar editor, metode ini tidak akan berpengaruh.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

addViewers(emailAddresses)

Menambahkan array pengguna tertentu ke daftar pelihat untuk Folder. Jika salah satu pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh bagi mereka.

Parameter

NamaJenisDeskripsi
emailAddressesString[]Array alamat email pengguna yang akan ditambahkan.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

createFile(blob)

Membuat file dalam folder saat ini 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.getRootFolder().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 folder saat ini 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.getRootFolder().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 dalam folder saat ini 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.getRootFolder().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 folder saat ini dengan nama yang diberikan.

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

getAccess(email)

Mendapatkan izin yang diberikan kepada pengguna tertentu.

Parameter

NamaJenisDeskripsi
emailStringalamat email pengguna yang izinnya harus diperiksa

Return

Permission — izin yang diberikan kepada 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

getAccess(user)

Mendapatkan izin yang diberikan kepada pengguna tertentu.

Parameter

NamaJenisDeskripsi
userUserrepresentasi pengguna yang izinnya harus diperiksa

Return

Permission — izin yang diberikan kepada 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

getDateCreated()

Mendapatkan tanggal Folder dibuat.

Return

Date — tanggal Folder dibuat

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

getDescription()

Mendapatkan deskripsi untuk Folder.

Return

String — deskripsi untuk Folder

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

getEditors()

Mendapatkan daftar editor untuk Folder ini. Jika pengguna yang menjalankan skrip tidak memiliki akses edit ke Folder, metode ini akan menampilkan array kosong.

// Gets a folder by its ID.
// TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of editors and logs their names to the console.
const editors = folder.getEditors();
for (editor of editors) {
  console.log(editor.getName());
}

Return

User[] — Daftar editor untuk Folder ini jika pengguna memiliki akses edit atau array kosong jika tidak.

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 yang merupakan turunan dari folder saat ini.

Return

FileIterator — Kumpulan semua file yang merupakan turunan dari folder saat ini.

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 yang merupakan turunan dari folder saat ini dan memiliki nama tertentu.

Parameter

NamaJenisDeskripsi
nameStringNama file yang akan ditemukan.

Return

FileIterator — Kumpulan semua file yang merupakan turunan dari folder saat ini dan 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 yang merupakan turunan dari folder saat ini dan memiliki jenis MIME yang ditentukan.

Parameter

NamaJenisDeskripsi
mimeTypeStringJenis file MIME yang akan ditemukan.

Return

FileIterator — Kumpulan semua file yang merupakan turunan dari folder saat ini dan 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

getFolders()

Mendapatkan koleksi semua folder yang merupakan turunan dari folder saat ini.

Return

FolderIterator — Kumpulan semua folder yang merupakan turunan dari folder saat ini.

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 yang merupakan turunan dari folder saat ini dan memiliki nama tertentu.

Parameter

NamaJenisDeskripsi
nameStringNama folder yang akan ditemukan.

Return

FolderIterator — Kumpulan semua folder yang merupakan turunan dari folder saat ini dan 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

getId()

Mendapatkan ID Folder.

Return

String — ID Folder

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

getLastUpdated()

Mendapatkan tanggal Folder terakhir diperbarui.

Return

Date — tanggal Folder terakhir diperbarui

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

getName()

Mendapatkan nama Folder.

Return

String — nama Folder

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

getOwner()

Mendapatkan pemilik Folder ini.

// Gets a folder by its ID.
// TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the owner of the folder and logs the name to the console.
const folderOwner = folder.getOwner();
console.log(folderOwner.getName());

Return

User — Pemilik Folder ini.

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

getParents()

Mendapatkan koleksi folder yang merupakan induk langsung dari Folder.

Return

FolderIterator — kumpulan folder yang merupakan induk langsung dari Folder

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

getResourceKey()

Mendapatkan kunci resource Folder yang diperlukan untuk mengakses item yang telah dibagikan menggunakan link.

Return

String — Kunci resource Folder.

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

getSecurityUpdateEligible()

Mendapatkan apakah Folder ini memenuhi syarat untuk menerapkan update keamanan yang memerlukan kunci resource untuk akses saat dibagikan menggunakan link.

Drive memerlukan kunci resource untuk mengakses beberapa file atau folder yang telah dibagikan menggunakan link. Perubahan ini adalah bagian dari update keamanan. Update diaktifkan secara default untuk file dan folder yang memenuhi syarat. Untuk mengaktifkan atau menonaktifkan persyaratan kunci resource bagi file yang memenuhi syarat, gunakan setSecurityUpdateEnabled.

Pelajari lebih lanjut Update keamanan untuk Google Drive.

Return

Boolean — Apakah persyaratan kunci resource dapat diterapkan untuk Folder atau tidak.

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

getSecurityUpdateEnabled()

Mendapatkan apakah Folder ini memerlukan kunci resource untuk akses saat dibagikan menggunakan link. Persyaratan ini diaktifkan secara default untuk file dan folder yang memenuhi syarat. Untuk mengaktifkan atau menonaktifkan persyaratan kunci resource bagi file yang memenuhi syarat, gunakan setSecurityUpdateEnabled.

Pelajari lebih lanjut Update keamanan untuk Google Drive.

Return

Boolean — Apakah persyaratan kunci resource diaktifkan untuk Folder ini atau tidak.

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

getSharingAccess()

Mendapatkan class pengguna yang dapat mengakses Folder, selain pengguna individu mana pun yang telah diberi akses secara eksplisit.

Return

Access — kelas pengguna mana yang dapat mengakses Folder

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

getSharingPermission()

Mendapatkan izin yang diberikan kepada pengguna yang dapat mengakses Folder, selain setiap pengguna yang telah diberi akses secara eksplisit.

Return

Permission — izin yang diberikan kepada pengguna yang dapat mengakses Folder

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

getSize()

Mendapatkan jumlah byte yang digunakan untuk menyimpan Folder di Drive. Perlu diketahui bahwa file aplikasi Google Workspace tidak mengurangi batas penyimpanan Drive, sehingga menampilkan 0 byte.

Return

Integer — jumlah byte yang digunakan untuk menyimpan Folder 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

getUrl()

Mendapatkan URL yang dapat digunakan untuk membuka Folder di Aplikasi Google seperti Drive atau Dokumen.

Return

String — URL yang dapat digunakan untuk melihat Folder ini di Aplikasi Google seperti Drive atau Dokumen

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

getViewers()

Mendapatkan daftar pelihat dan pengomentar untuk Folder ini. Jika pengguna yang menjalankan skrip tidak memiliki akses edit ke Folder, metode ini akan menampilkan array kosong.

// Gets a folder by its ID.
// TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of viewers and logs their names to the console.
const viewers = folder.getViewers();
for (viewer of viewers) {
  console.log(viewer.getName());
}

Return

User[] — Daftar pelihat dan pengomentar untuk Folder ini jika pengguna memiliki akses edit atau array kosong jika tidak.

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

isShareableByEditors()

Menentukan apakah pengguna dengan izin edit ke Folder diizinkan untuk berbagi dengan pengguna lain atau mengubah izin.

Return

Booleantrue jika pengguna dengan izin edit diizinkan untuk berbagi dengan pengguna lain atau mengubah izin; false jika tidak

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

isStarred()

Menentukan apakah Folder telah diberi bintang di Drive pengguna.

Return

Booleantrue jika Folder dibintangi di Drive pengguna; false jika tidak

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

isTrashed()

Menentukan apakah Folder ada di sampah Drive pengguna.

Return

Booleantrue jika Folder berada di sampah Drive pengguna; false jika tidak

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

moveTo(destination)

Memindahkan item ini ke folder tujuan yang diberikan.

Pengguna saat ini harus menjadi pemilik file atau memiliki setidaknya akses edit ke folder induk item saat ini untuk memindahkan item ke folder tujuan.

Parameter

NamaJenisDeskripsi
destinationFolderFolder yang menjadi induk baru.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

removeEditor(emailAddress)

Menghapus pengguna tertentu dari daftar editor untuk Folder. Metode ini tidak memblokir pengguna agar tidak mengakses Folder jika mereka termasuk dalam class pengguna yang memiliki akses umum—misalnya, jika Folder dibagikan ke seluruh domain pengguna, atau jika Folder berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

removeEditor(user)

Menghapus pengguna tertentu dari daftar editor untuk Folder. Metode ini tidak memblokir pengguna agar tidak mengakses Folder jika mereka termasuk dalam class pengguna yang memiliki akses umum—misalnya, jika Folder dibagikan ke seluruh domain pengguna, atau jika Folder berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

removeViewer(emailAddress)

Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Folder. Metode ini tidak akan berpengaruh jika pengguna adalah editor, bukan pelihat atau pengomentar. Metode ini juga tidak memblokir pengguna agar tidak mengakses Folder jika mereka termasuk dalam class pengguna yang memiliki akses umum—misalnya, jika Folder dibagikan dengan seluruh domain pengguna, atau jika Folder berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar editor.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Return

FolderFolder ini untuk perantaian.

Otorisasi

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

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

removeViewer(user)

Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk Folder. Metode ini tidak akan berpengaruh jika pengguna adalah editor, bukan pelihat. Metode ini juga tidak akan memblokir pengguna agar tidak mengakses Folder jika mereka termasuk dalam class pengguna yang memiliki akses umum—misalnya, jika Folder dibagikan ke seluruh domain pengguna, atau jika Folder berada di drive bersama yang dapat diakses pengguna.

Untuk file Drive, tindakan ini juga akan menghapus pengguna dari daftar editor.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Return

FolderFolder ini untuk perantaian.

Otorisasi

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

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

revokePermissions(emailAddress)

Mencabut akses ke Folder yang diberikan kepada pengguna tertentu. Metode ini tidak memblokir pengguna agar tidak mengakses Folder jika mereka termasuk dalam class pengguna yang memiliki akses umum — misalnya, jika Folder dibagikan ke seluruh domain pengguna.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang aksesnya harus dicabut.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

revokePermissions(user)

Mencabut akses ke Folder yang diberikan kepada pengguna tertentu. Metode ini tidak memblokir pengguna agar tidak mengakses Folder jika mereka termasuk dalam class pengguna yang memiliki akses umum — misalnya, jika Folder dibagikan ke seluruh domain pengguna.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang aksesnya harus dicabut.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

searchFiles(params)

Mendapatkan kumpulan semua file yang merupakan turunan dari folder saat ini dan 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 that are children of the current folder and modified after February 28,
// 2022 whose name contains "untitled.""
var files = DriveApp.getRootFolder().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 yang merupakan turunan dari folder saat ini dan 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 yang merupakan turunan dari folder saat ini dan 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 that are children of the current folder and you own and is starred.
var folders = DriveApp.getRootFolder().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 yang merupakan turunan dari folder saat ini dan 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

setDescription(description)

Menetapkan deskripsi untuk Folder.

Parameter

NamaJenisDeskripsi
descriptionStringdeskripsi baru untuk Folder

Return

FolderFolder ini, untuk perantaian

Otorisasi

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

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

setName(name)

Menetapkan nama Folder.

Parameter

NamaJenisDeskripsi
nameStringnama baru Folder

Return

FolderFolder ini, untuk perantaian

Otorisasi

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

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

setOwner(emailAddress)

Mengubah pemilik Folder. Metode ini juga memberi pemilik sebelumnya akses edit eksplisit ke Folder.

Parameter

NamaJenisDeskripsi
emailAddressStringalamat email pengguna yang akan menjadi pemilik baru

Return

FolderFolder ini, untuk perantaian

Otorisasi

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

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

setOwner(user)

Mengubah pemilik Folder. Metode ini juga memberi pemilik sebelumnya akses edit eksplisit ke Folder.

Parameter

NamaJenisDeskripsi
userUserrepresentasi pengguna yang akan menjadi pemilik baru

Return

FolderFolder ini, untuk perantaian

Otorisasi

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

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

setSecurityUpdateEnabled(enabled)

Menetapkan apakah Folder memerlukan kunci resource untuk akses saat dibagikan menggunakan link. File dan folder yang memenuhi syarat diaktifkan secara default.

Pelajari lebih lanjut Update keamanan untuk Google Drive.

Parameter

NamaJenisDeskripsi
enabledBooleanApakah akan mengaktifkan persyaratan kunci resource untuk Folder atau tidak.

Return

FolderFolder ini, untuk perantaian.

Otorisasi

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

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

setShareableByEditors(shareable)

Menetapkan apakah pengguna dengan izin edit ke Folder diizinkan untuk berbagi dengan pengguna lain atau mengubah izin. Default untuk Folder baru adalah true.

Parameter

NamaJenisDeskripsi
shareableBooleantrue jika pengguna dengan izin edit harus diizinkan untuk berbagi dengan pengguna lain atau mengubah izin; false jika tidak

Return

FolderFolder ini, untuk perantaian

Otorisasi

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

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

setSharing(accessType, permissionType)

Menetapkan class pengguna yang dapat mengakses Folder dan izin yang diberikan kepada pengguna tersebut, selain setiap pengguna yang telah diberi akses secara eksplisit.

// Creates a folder that anyone on the Internet can read from and write to. (Domain
// administrators can prohibit this setting for users of a Google Workspace domain.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parameter

NamaJenisDeskripsi
accessTypeAccesskelas pengguna mana yang harus dapat mengakses Folder
permissionTypePermissionizin yang harus diberikan kepada pengguna yang dapat mengakses Folder

Return

FolderFolder ini, untuk perantaian

Otorisasi

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

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

setStarred(starred)

Menetapkan apakah Folder dibintangi di Drive pengguna. Default untuk Folder baru adalah false.

Parameter

NamaJenisDeskripsi
starredBooleantrue jika Folder harus diberi bintang di Drive pengguna; false jika tidak

Return

FolderFolder ini, untuk perantaian

Otorisasi

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

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

setTrashed(trashed)

Menetapkan apakah Folder berada di sampah Drive pengguna. Hanya pemilik yang dapat membuang Folder. Default untuk Folder baru adalah false.

Parameter

NamaJenisDeskripsi
trashedBooleantrue jika Folder harus dipindahkan ke sampah Drive pengguna; false jika tidak

Return

FolderFolder ini, untuk perantaian

Otorisasi

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

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

Metode yang tidak digunakan lagi