File di Google Drive. File dapat diakses atau dibuat dari DriveApp
.
// Trash every untitled spreadsheet that hasn't been updated in a week. var files = DriveApp.getFilesByName('Untitled spreadsheet'); while (files.hasNext()) { var file = files.next(); if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) { file.setTrashed(true); } }
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
addCommenter(emailAddress) | File | Tambahkan pengguna yang ditentukan ke daftar pemberi komentar untuk File . |
addCommenter(user) | File | Tambahkan pengguna yang ditentukan ke daftar pemberi komentar untuk File . |
addCommenters(emailAddresses) | File | Tambahkan array pengguna yang ditentukan ke daftar pemberi komentar untuk File . |
addEditor(emailAddress) | File | Menambahkan pengguna tertentu ke daftar editor untuk File . |
addEditor(user) | File | Menambahkan pengguna tertentu ke daftar editor untuk File . |
addEditors(emailAddresses) | File | Menambahkan array pengguna yang ditentukan ke daftar editor untuk File . |
addViewer(emailAddress) | File | Menambahkan pengguna tertentu ke daftar audiens untuk File . |
addViewer(user) | File | Menambahkan pengguna tertentu ke daftar audiens untuk File . |
addViewers(emailAddresses) | File | Menambahkan array pengguna yang ditentukan ke daftar audiens untuk File . |
getAccess(email) | Permission | Mendapatkan izin yang diberikan kepada pengguna tertentu. |
getAccess(user) | Permission | Mendapatkan izin yang diberikan kepada pengguna tertentu. |
getAs(contentType) | Blob | Menampilkan data di dalam objek ini sebagai blob yang dikonversi ke jenis konten yang ditentukan. |
getBlob() | Blob | Tampilkan data di dalam objek ini sebagai blob. |
getDateCreated() | Date | Mendapatkan tanggal File dibuat. |
getDescription() | String | Mendapatkan deskripsi untuk File . |
getDownloadUrl() | String | Mendapatkan URL yang dapat digunakan untuk mendownload file. |
getEditors() | User[] | Mendapatkan daftar editor untuk File ini. |
getId() | String | Mendapatkan ID File . |
getLastUpdated() | Date | Mendapatkan tanggal File terakhir diperbarui. |
getMimeType() | String | Mendapatkan jenis MIME dari file. |
getName() | String | Mendapatkan nama File . |
getOwner() | User | Mendapatkan pemilik file. |
getParents() | FolderIterator | Mendapatkan koleksi folder yang merupakan induk langsung dari File . |
getResourceKey() | String | Mendapatkan kunci resource File yang diperlukan untuk mengakses item yang telah dibagikan menggunakan link. |
getSecurityUpdateEligible() | Boolean | Mendapatkan apakah File ini memenuhi syarat untuk menerapkan update keamanan yang
memerlukan kunci resource untuk akses saat dibagikan menggunakan link. |
getSecurityUpdateEnabled() | Boolean | Mendapatkan apakah File ini memerlukan kunci resource untuk akses saat
dibagikan menggunakan link. |
getSharingAccess() | Access | Mendapatkan class pengguna mana yang dapat mengakses File , selain setiap pengguna
yang telah diberi akses secara eksplisit. |
getSharingPermission() | Permission | Mendapatkan izin yang diberikan kepada pengguna yang dapat mengakses File ,
di samping setiap pengguna yang telah diberi akses secara eksplisit. |
getSize() | Integer | Mendapatkan jumlah byte yang digunakan untuk menyimpan File di Drive. |
getTargetId() | String | Jika ini adalah Pintasan, akan menampilkan ID item yang ditunjuk. |
getTargetMimeType() | String | Jika ini adalah Pintasan, akan menampilkan jenis MIME dari item yang ditunjuk. |
getTargetResourceKey() | String | Jika file adalah pintasan, akan menampilkan kunci resource item yang ditunjuknya. |
getThumbnail() | Blob | Mendapatkan gambar thumbnail untuk file, atau null jika tidak ada thumbnail. |
getUrl() | String | Mendapatkan 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() | Boolean | Menentukan apakah pengguna dengan izin edit ke File diizinkan untuk
berbagi dengan pengguna lain atau mengubah izin. |
isStarred() | Boolean | Menentukan apakah File telah diberi bintang di Drive pengguna. |
isTrashed() | Boolean | Menentukan apakah File ada di sampah Drive pengguna. |
makeCopy() | File | Membuat salinan file. |
makeCopy(destination) | File | Membuat salinan file di direktori tujuan. |
makeCopy(name) | File | Membuat salinan file dan menamainya dengan nama yang diberikan. |
makeCopy(name, destination) | File | Membuat salinan file di direktori tujuan dan menamainya dengan nama yang diberikan. |
moveTo(destination) | File | Memindahkan item ini ke folder tujuan yang disediakan. |
removeCommenter(emailAddress) | File | Menghapus pengguna tertentu dari daftar pemberi komentar untuk File . |
removeCommenter(user) | File | Menghapus pengguna tertentu dari daftar pemberi komentar untuk File . |
removeEditor(emailAddress) | File | Menghapus pengguna yang ditentukan dari daftar editor untuk File . |
removeEditor(user) | File | Menghapus pengguna yang ditentukan dari daftar editor untuk File . |
removeViewer(emailAddress) | File | Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk File . |
removeViewer(user) | File | Menghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk File . |
revokePermissions(emailAddress) | File | Mencabut akses ke File yang diberikan kepada pengguna tertentu. |
revokePermissions(user) | File | Mencabut akses ke File yang diberikan kepada pengguna tertentu. |
setContent(content) | File | Mengganti konten file dengan pengganti yang diberikan. |
setDescription(description) | File | Menetapkan deskripsi untuk File . |
setName(name) | File | Menetapkan nama File . |
setOwner(emailAddress) | File | Mengubah pemilik File . |
setOwner(user) | File | Mengubah pemilik File . |
setSecurityUpdateEnabled(enabled) | File | Menetapkan apakah File memerlukan kunci resource untuk diakses saat dibagikan
menggunakan link. |
setShareableByEditors(shareable) | File | Menetapkan apakah pengguna dengan izin edit ke File diizinkan untuk berbagi
dengan pengguna lain atau mengubah izin. |
setSharing(accessType, permissionType) | File | Menetapkan class pengguna yang dapat mengakses File dan izin yang diberikan kepada pengguna tersebut, selain setiap pengguna yang telah diberi akses secara eksplisit. |
setStarred(starred) | File | Menetapkan apakah File diberi bintang di Drive pengguna. |
setTrashed(trashed) | File | Menetapkan apakah File ada di sampah Drive pengguna. |
Dokumentasi mendetail
addCommenter(emailAddress)
Tambahkan pengguna yang ditentukan ke daftar pemberi komentar untuk File
. Jika pengguna
sudah ada dalam daftar pelihat, metode ini akan mempromosikan pengguna tersebut dari daftar pelihat.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' with the email address that you // want to add as a commenter. while (files.hasNext()) { const file = files.next(); email = 'cloudysanfrancisco@gmail.com'; console.log(file.addCommenter(email)); }
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddress | String | Alamat email pengguna yang akan ditambahkan. |
Return
File
— File
ini, untuk perantaian.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
addCommenter(user)
Tambahkan pengguna yang ditentukan ke daftar pemberi komentar untuk File
. Jika pengguna
sudah ada dalam daftar pelihat, metode ini akan mempromosikan pengguna tersebut dari daftar pelihat.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Adds the active user as a commenter. while (files.hasNext()) { const file = files.next(); file.addCommenter(Session.getActiveUser()); }
Parameter
Nama | Type | Deskripsi |
---|---|---|
user | User | Representasi pengguna yang akan ditambahkan. |
Return
File
— File
ini, untuk perantaian.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
addCommenters(emailAddresses)
Tambahkan array pengguna yang ditentukan ke daftar pemberi komentar untuk File
. Jika ada
pengguna yang sudah ada di daftar pelihat, metode ini akan mempromosikannya dari daftar
penonton.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); while (files.hasNext()) { const file = files.next(); // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and // 'baklavainthebalkans@gmail.com' with the email addresses to add as commenters. const emails = ['cloudysanfrancisco@gmail.com','baklavainthebalkans@gmail.com']; console.log(file.addCommenters(emails)); }
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddresses | String[] | Array alamat email pengguna yang akan ditambahkan. |
Return
File
— File
ini, untuk perantaian.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
addEditor(emailAddress)
Menambahkan pengguna tertentu ke daftar editor untuk File
. Jika pengguna sudah ada dalam daftar pelihat, metode ini akan mempromosikannya dari daftar pelihat.
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddress | String | Alamat email pengguna yang akan ditambahkan. |
Return
File
— File
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 File
. Jika pengguna sudah ada dalam daftar pelihat, metode ini akan mempromosikannya dari daftar pelihat.
Parameter
Nama | Type | Deskripsi |
---|---|---|
user | User | Representasi pengguna yang akan ditambahkan. |
Return
File
— File
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 yang ditentukan ke daftar editor untuk File
. Jika ada
pengguna yang sudah ada di daftar audiens, metode ini akan mempromosikannya dari daftar
penonton.
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddresses | String[] | Array alamat email pengguna yang akan ditambahkan. |
Return
File
— File
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 audiens untuk File
. Jika pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh.
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddress | String | Alamat email pengguna yang akan ditambahkan. |
Return
File
— File
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 audiens untuk File
. Jika pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh.
Parameter
Nama | Type | Deskripsi |
---|---|---|
user | User | Representasi pengguna yang akan ditambahkan. |
Return
File
— File
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 yang ditentukan ke daftar audiens untuk File
. Jika ada
pengguna yang sudah ada di daftar editor, metode ini tidak akan berpengaruh bagi mereka.
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddresses | String[] | Array alamat email pengguna yang akan ditambahkan. |
Return
File
— File
ini, untuk perantaian.
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
Nama | Type | Deskripsi |
---|---|---|
email | String | alamat 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
Nama | Type | Deskripsi |
---|---|---|
user | User | representasi 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
getAs(contentType)
Menampilkan data di dalam objek ini sebagai blob yang dikonversi ke jenis konten yang ditentukan. Metode ini menambahkan ekstensi yang sesuai ke nama file—misalnya, "myfile.pdf". Namun, diasumsikan bahwa bagian dari nama file yang mengikuti titik terakhir (jika ada) adalah ekstensi yang sudah ada dan harus diganti. Akibatnya, "ShoppingList.12.25.2014" menjadi "ShoppingList.12.25.pdf".
Untuk melihat kuota harian untuk konversi, lihat Kuota untuk Layanan Google. Domain Google Workspace yang baru dibuat mungkin tunduk pada kuota yang lebih ketat.
Parameter
Nama | Type | Deskripsi |
---|---|---|
contentType | String | Jenis MIME yang akan dikonversi. Untuk sebagian besar blob, 'application/pdf' adalah satu-satunya opsi yang valid. Untuk gambar dalam format BMP, GIF, JPEG, atau PNG, salah satu dari 'image/bmp' , 'image/gif' , 'image/jpeg' , atau 'image/png' juga
valid. |
Return
Blob
— Data sebagai blob.
getBlob()
getDateCreated()
getDescription()
getDownloadUrl()
Mendapatkan URL yang dapat digunakan untuk mendownload file. Hanya pengguna yang memiliki izin untuk membuka file
di Google Drive yang dapat mengakses URL. Anda dapat menggunakan URL ini di browser untuk mendownload file, tetapi
tidak dapat digunakan untuk mengambil file dengan UrlFetchApp
. Jika Anda ingin konten file
dalam skrip, gunakan getBlob()
.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the download URLs to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getDownloadUrl()); }
Return
String
— URL yang dapat digunakan untuk mendownload file.
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 File
ini. Jika pengguna yang mengeksekusi skrip
tidak memiliki akses edit ke File
, metode ini akan menampilkan array kosong.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Adds the email addresses in the array as editors of each file. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' // and 'baklavainthebalkans@gmail.com' with valid email addresses. file.addEditors(['cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com']); // Gets a list of the file editors. const editors = file.getEditors(); // For each file, logs the editors' email addresses to the console. for (const editor of editors) { console.log(editor.getEmail()); } }
Return
User[]
— Jika pengguna memiliki akses edit untuk File
ini, daftar editor akan ditampilkan. Jika pengguna tidak memiliki akses edit, akan menampilkan array kosong.
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()
getLastUpdated()
getMimeType()
Mendapatkan jenis MIME dari file.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the MIME type to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getMimeType()); }
Return
String
— Jenis MIME file.
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()
getOwner()
Mendapatkan pemilik file.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the names of the file owners to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getOwner().getName()); }
Return
User
— Pemilik file.
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 File
.
Return
FolderIterator
— kumpulan folder yang merupakan induk langsung dari File
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 File
yang diperlukan untuk mengakses item yang telah dibagikan menggunakan link.
Return
String
— Kunci resource File
.
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 File
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 File
.
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 File
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 untuk file yang memenuhi syarat, gunakan
setSecurityUpdateEnabled
.
Pelajari lebih lanjut Update keamanan untuk Google Drive.
Return
Boolean
— Apakah persyaratan kunci resource diaktifkan untuk File
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 mana yang dapat mengakses File
, selain setiap pengguna
yang telah diberi akses secara eksplisit.
Return
Access
— class pengguna mana yang dapat mengakses File
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 File
,
di samping setiap pengguna yang telah diberi akses secara eksplisit.
Return
Permission
— izin yang diberikan kepada pengguna yang dapat mengakses File
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 File
di Drive. Perlu diperhatikan bahwa
file aplikasi Google Workspace tidak diperhitungkan dalam batas penyimpanan Drive, sehingga menampilkan
0
byte.
Return
Integer
— jumlah byte yang digunakan untuk menyimpan File
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
getTargetId()
Jika ini adalah Pintasan, akan menampilkan ID item yang ditunjuk.
Jika tidak, metode ini akan menampilkan null
.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the target ID of the shortcut. console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);
Return
String
— ID item target.
getTargetMimeType()
Jika ini adalah Pintasan, akan menampilkan jenis MIME dari item yang ditunjuk.
Jika tidak, metode ini akan menampilkan null
.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the MIME type of the file that the shortcut points to. console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);
Return
String
— Jenis MIME item target.
getTargetResourceKey()
Jika file adalah pintasan, akan menampilkan kunci resource item yang ditunjuknya. Kunci resource adalah parameter tambahan yang harus diteruskan untuk mengakses file yang telah dibagikan menggunakan link.
Jika file bukan pintasan, metode ini akan menampilkan null
.
Return
String
— Kunci resource item target atau null
jika file bukan pintasan.
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
getThumbnail()
Mendapatkan gambar thumbnail untuk file, atau null
jika tidak ada thumbnail.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Logs the thumbnail image for each file to the console as a blob, // or null if no thumbnail exists. console.log(file.getThumbnail()); }
Return
Blob
— Gambar thumbnail untuk file.
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 File
di Aplikasi Google seperti Drive atau Dokumen.
Return
String
— URL yang dapat digunakan untuk melihat File
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 File
ini. Jika pengguna yang
menjalankan skrip tidak memiliki akses edit ke File
, metode ini
akan menampilkan array kosong.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // For each file, logs the viewers' email addresses to the console. const viewers = file.getViewers(); for (viewer of viewers) { console.log(viewer.getEmail()); } }
Return
User[]
— Jika pengguna memiliki akses edit untuk File
ini, yang menampilkan daftar
pelihat dan pengomentar. Jika pengguna tidak memiliki akses edit, akan menampilkan array kosong.
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 File
telah diberi bintang di Drive pengguna.
Return
Boolean
— true
jika File
berbintang 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 File
ada di sampah Drive pengguna.
Return
Boolean
— true
jika File
ada 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
makeCopy()
Membuat salinan file.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and logs the file name to the console. console.log(file.makeCopy().getName()); }
Return
File
— Salinan baru.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
makeCopy(destination)
Membuat salinan file di direktori tujuan.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and adds it to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy(destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
Parameter
Nama | Type | Deskripsi |
---|---|---|
destination | Folder | Direktori tujuan penyalinan file. |
Return
File
— Salinan baru.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
makeCopy(name)
Membuat salinan file dan menamainya dengan nama yang diberikan.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and sets the name to 'Test-Copy.' const filename = file.makeCopy('Test-Copy'); // Logs the copied file's name to the console. console.log(filename.getName()); }
Parameter
Nama | Type | Deskripsi |
---|---|---|
name | String | Nama file yang harus diterapkan ke salinan baru. |
Return
File
— Salinan baru.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
makeCopy(name, destination)
Membuat salinan file di direktori tujuan dan menamainya dengan nama yang diberikan.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file, sets the file name, and adds the copied file // to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy('Test-Copy', destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
Parameter
Nama | Type | Deskripsi |
---|---|---|
name | String | Nama file yang harus diterapkan ke salinan baru. |
destination | Folder | Direktori tujuan penyalinan file. |
Return
File
— Salinan baru.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
moveTo(destination)
Memindahkan item ini ke folder tujuan yang disediakan.
Pengguna saat ini harus menjadi pemilik file atau memiliki setidaknya akses edit ke folder induk item saat ini agar dapat memindahkan item ke folder tujuan.
Parameter
Nama | Type | Deskripsi |
---|---|---|
destination | Folder | Folder yang menjadi induk baru. |
Return
File
— File
ini, untuk perantaian.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
removeCommenter(emailAddress)
Menghapus pengguna tertentu dari daftar pemberi komentar untuk File
. Metode ini
tidak memblokir pengguna untuk mengakses File
jika mereka termasuk dalam class pengguna
yang memiliki akses umum — misalnya, jika File
dibagikan kepada seluruh
domain pengguna.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. // TODO(developer): Replace the email with the email of the user you want to remove. file.removeCommenter('cloudysanfrancisco@gmail.com'); }
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddress | String | Alamat email pengguna yang akan dihapus. |
Return
File
— File
ini, untuk perantaian.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
removeCommenter(user)
Menghapus pengguna tertentu dari daftar pemberi komentar untuk File
. Metode ini
tidak memblokir pengguna untuk mengakses File
jika mereka termasuk dalam class pengguna
yang memiliki akses umum — misalnya, jika File
dibagikan kepada seluruh
domain pengguna.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. console.log(file.removeCommenter(Session.getActiveUser())); }
Parameter
Nama | Type | Deskripsi |
---|---|---|
user | User | Representasi pengguna yang akan dihapus. |
Return
File
— File
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 yang ditentukan dari daftar editor untuk File
. Metode ini tidak
memblokir pengguna untuk mengakses File
jika mereka termasuk dalam class pengguna yang memiliki
akses umum—misalnya, jika File
dibagikan ke seluruh domain
pengguna, atau jika File
berada di drive bersama yang dapat diakses pengguna.
Untuk file Drive, pengguna juga akan dihapus dari daftar pelihat.
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddress | String | Alamat email pengguna yang akan dihapus. |
Return
File
— File
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 yang ditentukan dari daftar editor untuk File
. Metode ini tidak
memblokir pengguna untuk mengakses File
jika mereka termasuk dalam class pengguna yang memiliki
akses umum—misalnya, jika File
dibagikan ke seluruh domain
pengguna, atau jika File
berada di drive bersama yang dapat diakses pengguna.
Untuk file Drive, pengguna juga akan dihapus dari daftar pelihat.
Parameter
Nama | Type | Deskripsi |
---|---|---|
user | User | Representasi pengguna yang akan dihapus. |
Return
File
— File
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 File
. Metode
ini tidak berpengaruh jika pengguna adalah editor, bukan pelihat atau pengomentar. Metode ini juga
tidak memblokir pengguna untuk mengakses File
jika mereka termasuk dalam class pengguna yang
memiliki akses umum—misalnya, jika File
dibagikan kepada seluruh
domain pengguna, atau jika File
berada di drive bersama yang dapat diakses pengguna.
Untuk file Drive, pengguna juga akan dihapus dari daftar editor.
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddress | String | Alamat email pengguna yang akan dihapus. |
Return
File
— File
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 File
. Metode
ini tidak berpengaruh jika pengguna adalah editor, bukan pelihat. Metode ini juga tidak memblokir
pengguna untuk mengakses File
jika mereka termasuk dalam class pengguna yang memiliki akses
umum—misalnya, jika File
dibagikan kepada seluruh domain pengguna, atau
jika File
berada dalam drive bersama yang dapat diakses pengguna.
Untuk file Drive, pengguna juga akan dihapus dari daftar editor.
Parameter
Nama | Type | Deskripsi |
---|---|---|
user | User | Representasi pengguna yang akan dihapus. |
Return
File
— File
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 File
yang diberikan kepada pengguna tertentu. Metode ini tidak
memblokir pengguna untuk mengakses File
jika mereka termasuk dalam class pengguna yang
memiliki akses umum — misalnya, jika File
dibagikan ke seluruh
domain pengguna.
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddress | String | Alamat email pengguna yang aksesnya harus dicabut. |
Return
File
— File
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 File
yang diberikan kepada pengguna tertentu. Metode ini tidak
memblokir pengguna untuk mengakses File
jika mereka termasuk dalam class pengguna yang
memiliki akses umum — misalnya, jika File
dibagikan ke seluruh
domain pengguna.
Parameter
Nama | Type | Deskripsi |
---|---|---|
user | User | Representasi pengguna yang aksesnya harus dicabut. |
Return
File
— File
ini, untuk perantaian.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
setContent(content)
Mengganti konten file dengan pengganti yang diberikan. Menampilkan pengecualian jika content
lebih besar dari 10 MB.
// Creates a text file with the content 'Hello, world!' file = DriveApp.createFile('New Text File', 'Hello, world!'); // Logs the content of the text file to the console. console.log(file.getBlob().getDataAsString()); // Updates the content of the text file to 'Updated text!' file.setContent('Updated text!') // Logs content of the text file to the console. console.log(file.getBlob().getDataAsString());
Parameter
Nama | Type | Deskripsi |
---|---|---|
content | String | Konten baru untuk file. |
Return
File
— File
ini, untuk perantaian.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
setDescription(description)
setName(name)
setOwner(emailAddress)
Mengubah pemilik File
. Metode ini juga memberi pemilik sebelumnya
akses edit eksplisit ke File
.
Parameter
Nama | Type | Deskripsi |
---|---|---|
emailAddress | String | alamat email pengguna yang seharusnya menjadi pemilik baru |
Return
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
setOwner(user)
Mengubah pemilik File
. Metode ini juga memberi pemilik sebelumnya
akses edit eksplisit ke File
.
Parameter
Nama | Type | Deskripsi |
---|---|---|
user | User | representasi pengguna yang akan menjadi pemilik baru |
Return
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
setSecurityUpdateEnabled(enabled)
Menetapkan apakah File
memerlukan kunci resource untuk diakses saat dibagikan
menggunakan link. File dan folder yang memenuhi syarat diaktifkan secara default.
Pelajari lebih lanjut Update keamanan untuk Google Drive.
Parameter
Nama | Type | Deskripsi |
---|---|---|
enabled | Boolean | Apakah akan mengaktifkan persyaratan kunci resource untuk File . |
Return
File
— File
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 File
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
Nama | Type | Deskripsi |
---|---|---|
accessType | Access | class pengguna mana yang harus dapat mengakses File |
permissionType | Permission | izin yang harus diberikan kepada pengguna yang dapat mengakses File |
Return
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
setStarred(starred)
Menetapkan apakah File
diberi bintang di Drive pengguna. Default untuk
File
baru adalah false
.
Parameter
Nama | Type | Deskripsi |
---|---|---|
starred | Boolean | true jika File harus diberi bintang di Drive
pengguna; false jika tidak |
Return
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
setTrashed(trashed)
Menetapkan apakah File
ada di sampah Drive pengguna. Hanya
pemilik yang dapat membuang File
. Default untuk File
baru adalah false
.
Parameter
Nama | Type | Deskripsi |
---|---|---|
trashed | Boolean | true jika File harus dipindahkan ke sampah di Drive pengguna; false jika tidak |
Return
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive