Class File

File

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

MetodeJenis hasil yang ditampilkanDeskripsi singkat
addCommenter(emailAddress)FileTambahkan pengguna yang ditentukan ke daftar pemberi komentar untuk File.
addCommenter(user)FileTambahkan pengguna yang ditentukan ke daftar pemberi komentar untuk File.
addCommenters(emailAddresses)FileTambahkan array pengguna yang ditentukan 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 ditentukan ke daftar editor untuk File.
addViewer(emailAddress)FileMenambahkan pengguna tertentu ke daftar audiens untuk File.
addViewer(user)FileMenambahkan pengguna tertentu ke daftar audiens untuk File.
addViewers(emailAddresses)FileMenambahkan array pengguna yang ditentukan ke daftar audiens 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()BlobTampilkan data di dalam objek ini sebagai blob.
getDateCreated()DateMendapatkan tanggal File dibuat.
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 dari file.
getName()StringMendapatkan nama File.
getOwner()UserMendapatkan pemilik file.
getParents()FolderIteratorMendapatkan koleksi folder yang merupakan induk langsung dari 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 mana yang dapat mengakses File, selain setiap pengguna yang telah diberi akses secara eksplisit.
getSharingPermission()PermissionMendapatkan izin yang diberikan kepada pengguna yang dapat mengakses File, di samping setiap pengguna yang telah diberi akses secara eksplisit.
getSize()IntegerMendapatkan jumlah byte yang digunakan untuk menyimpan File di Drive.
getTargetId()StringJika ini adalah Pintasan, akan menampilkan ID item yang ditunjuk.
getTargetMimeType()StringJika ini adalah Pintasan, akan menampilkan jenis MIME dari item yang ditunjuk.
getTargetResourceKey()StringJika file adalah pintasan, akan 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 berbagi 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 menamainya 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 yang ditentukan dari daftar editor untuk File.
removeEditor(user)FileMenghapus pengguna yang ditentukan dari daftar editor untuk File.
removeViewer(emailAddress)FileMenghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk File.
removeViewer(user)FileMenghapus pengguna tertentu dari daftar pelihat dan pengomentar untuk File.
revokePermissions(emailAddress)FileMencabut akses ke File yang diberikan kepada pengguna tertentu.
revokePermissions(user)FileMencabut akses ke File yang diberikan kepada pengguna tertentu.
setContent(content)FileMengganti konten file dengan pengganti yang diberikan.
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 diakses 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 setiap pengguna 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.

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

NamaTypeDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Return

FileFile 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

NamaTypeDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Return

FileFile 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

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

Return

FileFile 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

NamaTypeDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Return

FileFile 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

NamaTypeDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Return

FileFile 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

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

Return

FileFile 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

NamaTypeDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Return

FileFile 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

NamaTypeDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Return

FileFile 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

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

Return

FileFile 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

NamaTypeDeskripsi
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

NamaTypeDeskripsi
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

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

NamaTypeDeskripsi
contentTypeStringJenis 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()

Tampilkan data di dalam objek ini sebagai blob.

Return

Blob — Data sebagai blob.


getDateCreated()

Mendapatkan tanggal File dibuat.

Return

Date — tanggal pembuatan 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

getDescription()

Mendapatkan deskripsi untuk File.

Return

String — deskripsi 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

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()

Mendapatkan ID File.

Return

String — ID 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

getLastUpdated()

Mendapatkan tanggal File terakhir diperbarui.

Return

Date — tanggal File 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

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()

Mendapatkan nama File.

Return

String — nama 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

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

isShareableByEditors()

Menentukan apakah pengguna dengan izin edit ke File 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 File telah diberi bintang di Drive pengguna.

Return

Booleantrue 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

Booleantrue 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

NamaTypeDeskripsi
destinationFolderDirektori 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

NamaTypeDeskripsi
nameStringNama 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

NamaTypeDeskripsi
nameStringNama file yang harus diterapkan ke salinan baru.
destinationFolderDirektori 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

NamaTypeDeskripsi
destinationFolderFolder yang menjadi induk baru.

Return

FileFile 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

NamaTypeDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Return

FileFile 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

NamaTypeDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Return

FileFile 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

NamaTypeDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Return

FileFile 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

NamaTypeDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Return

FileFile 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

NamaTypeDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Return

FileFile 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

NamaTypeDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Return

FileFile 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

NamaTypeDeskripsi
emailAddressStringAlamat email pengguna yang aksesnya harus dicabut.

Return

FileFile 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

NamaTypeDeskripsi
userUserRepresentasi pengguna yang aksesnya harus dicabut.

Return

FileFile 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

NamaTypeDeskripsi
contentStringKonten baru untuk file.

Return

FileFile 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)

Menetapkan deskripsi untuk File.

Parameter

NamaTypeDeskripsi
descriptionStringdeskripsi baru untuk File

Return

FileFile ini, untuk rantai

Otorisasi

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

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

setName(name)

Menetapkan nama File.

Parameter

NamaTypeDeskripsi
nameStringnama baru File

Return

FileFile ini, untuk rantai

Otorisasi

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

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

setOwner(emailAddress)

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

Parameter

NamaTypeDeskripsi
emailAddressStringalamat email pengguna yang seharusnya menjadi pemilik baru

Return

FileFile ini, untuk rantai

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

NamaTypeDeskripsi
userUserrepresentasi pengguna yang akan menjadi pemilik baru

Return

FileFile ini, untuk rantai

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

NamaTypeDeskripsi
enabledBooleanApakah akan mengaktifkan persyaratan kunci resource untuk File.

Return

FileFile 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 File diizinkan untuk berbagi dengan pengguna lain atau mengubah izin. Default untuk File baru adalah true.

Parameter

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

Return

FileFile ini, untuk rantai

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

NamaTypeDeskripsi
accessTypeAccessclass pengguna mana yang harus dapat mengakses File
permissionTypePermissionizin yang harus diberikan kepada pengguna yang dapat mengakses File

Return

FileFile ini, untuk rantai

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

NamaTypeDeskripsi
starredBooleantrue jika File harus diberi bintang di Drive pengguna; false jika tidak

Return

FileFile ini, untuk rantai

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

NamaTypeDeskripsi
trashedBooleantrue jika File harus dipindahkan ke sampah di Drive pengguna; false jika tidak

Return

FileFile ini, untuk rantai

Otorisasi

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

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