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

Dokumentasi mendetail

addCommenter(emailAddress)

Tambahkan pengguna yang diberikan ke daftar pemberi komentar untuk File. Jika pengguna sudah ada dalam daftar penonton, metode ini akan mempromosikan pengguna dari daftar penonton. 

const files = DriveApp.getFilesByName('Test');

// Loops through the files
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter('hello@example.com');
}

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Pulang pergi

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 diberikan ke daftar pemberi komentar untuk File. Jika pengguna sudah ada dalam daftar penonton, metode ini akan mempromosikan pengguna 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');

// Adds the active user as a commenter.
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter(Session.getActiveUser());
}

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Pulang pergi

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 diberikan ke daftar pemberi komentar untuk File. Jika ada pengguna yang sudah ada dalam daftar penonton, metode ini akan mempromosikan mereka 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

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

Pulang pergi

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 penonton, metode ini akan mempromosikan pengguna dari daftar penonton.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Pulang pergi

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 penonton, metode ini akan mempromosikan pengguna dari daftar penonton.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Pulang pergi

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 diberikan ke daftar editor untuk File. Jika ada pengguna yang sudah ada dalam daftar penonton, metode ini akan mempromosikan mereka dari daftar penonton.

Parameter

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

Pulang pergi

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 yang diberikan ke daftar penonton untuk File. Jika pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan ditambahkan.

Pulang pergi

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 yang diberikan ke daftar penonton untuk File. Jika pengguna sudah ada dalam daftar editor, metode ini tidak akan berpengaruh.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan ditambahkan.

Pulang pergi

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 diberikan ke daftar penonton untuk File. 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.

Pulang pergi

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. Metode ini tidak mendukung pengembalian izin untuk Google Grup atau izin yang diwarisi melalui Google Grup.

Parameter

NamaJenisDeskripsi
emailStringAlamat email pengguna yang izinnya harus diperiksa. Google Grup tidak didukung.

Pulang pergi

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. Metode ini tidak mendukung pengembalian izin untuk Google Grup atau izin yang diwarisi melalui Google Grup.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang izinnya harus diperiksa.

Pulang pergi

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, hal ini menganggap bahwa bagian nama file yang mengikuti titik terakhir (jika ada) adalah ekstensi yang ada dan harus diganti. Akibatnya, "ShoppingList.12.25.2014" menjadi "ShoppingList.12.25.pdf".

Untuk melihat kuota harian konversi, lihat Kuota untuk Layanan Google. Domain Google Workspace yang baru dibuat mungkin akan dikenai kuota yang lebih ketat untuk sementara.

Parameter

NamaJenisDeskripsi
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, 'image/bmp', 'image/gif', 'image/jpeg', atau 'image/png' juga valid. Untuk dokumen Google Dokumen, 'text/markdown' juga valid.

Pulang pergi

Blob — Data sebagai blob.

getBlob()

Menampilkan data di dalam objek ini sebagai blob.

Pulang pergi

Blob — Data sebagai blob.

getDateCreated()

Mendapatkan tanggal pembuatan File.

Pulang pergi

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

Pulang pergi

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 menginginkan 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());
}

Pulang pergi

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

  // 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());
  }
}

Pulang pergi

User[] — Jika pengguna memiliki akses edit untuk File ini, menampilkan daftar editor. Jika pengguna tidak memiliki akses edit, array kosong akan ditampilkan.

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.

Pulang pergi

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.

Pulang pergi

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

Pulang pergi

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.

Pulang pergi

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

Pulang pergi

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 kumpulan folder yang merupakan induk langsung File.

Pulang pergi

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.

Pulang pergi

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 merupakan bagian dari update keamanan. Pembaruan 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.

Pulang pergi

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.

Pulang pergi

Boolean — Apakah persyaratan kunci resource diaktifkan untuk File 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

getSharingAccess()

Mendapatkan class pengguna yang dapat mengakses File, selain pengguna individual yang telah diberi akses secara eksplisit.

Pulang pergi

Access — class 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

getSharingPermission()

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

Pulang pergi

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. Perhatikan bahwa file aplikasi Google Workspace tidak mengurangi batas penyimpanan Drive sehingga menampilkan 0 byte.

Pulang pergi

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, tampilkan ID item yang ditunjuknya.

Jika tidak, null akan ditampilkan. 

// 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()}`);

Pulang pergi

String — ID item target.

getTargetMimeType()

Jika ini adalah Pintasan, tampilkan jenis mime item yang ditunjuknya.

Jika tidak, null akan ditampilkan. 

// 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()}`);

Pulang pergi

String — Jenis MIME item target.

getTargetResourceKey()

Jika file adalah pintasan, menampilkan kunci resource item yang ditunjuknya. Kunci resource adalah parameter tambahan yang perlu Anda teruskan untuk mengakses file yang telah dibagikan menggunakan link.

Jika bukan pintasan, file akan menampilkan null. 

//  Gets a file by its ID.
//  TODO(developer): Replace 'abc123456' with your file ID.
const file = DriveApp.getFileById('abc123456');

// If the file is a shortcut, returns the resource key of the file that it
// points to.
console.log(file.getTargetResourceKey());

Pulang pergi

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

Pulang pergi

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.

Pulang pergi

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 (const viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

Pulang pergi

User[] — Jika pengguna memiliki akses edit untuk File ini, menampilkan daftar pelihat dan pemberi komentar. Jika pengguna tidak memiliki akses edit, array kosong akan ditampilkan.

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 membagikan dengan pengguna lain atau mengubah izin.

Pulang pergi

Boolean — true 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.

Pulang pergi

Boolean — true jika File diberi bintang 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.

Pulang pergi

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

Pulang pergi

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

NamaJenisDeskripsi
destinationFolderDirektori tempat file akan disalin.

Pulang pergi

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 memberi nama 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

NamaJenisDeskripsi
nameStringNama file yang akan diterapkan ke salinan baru.

Pulang pergi

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

NamaJenisDeskripsi
nameStringNama file yang akan diterapkan ke salinan baru.
destinationFolderDirektori tempat file akan disalin.

Pulang pergi

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 setidaknya memiliki akses edit ke folder induk item saat ini untuk memindahkan item ke folder tujuan.

Parameter

NamaJenisDeskripsi
destinationFolderFolder yang menjadi induk baru.

Pulang pergi

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 agar tidak mengakses File jika mereka termasuk dalam class pengguna yang memiliki akses umum — misalnya, jika File dibagikan ke 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

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Pulang pergi

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 agar tidak mengakses File jika mereka termasuk dalam class pengguna yang memiliki akses umum — misalnya, jika File dibagikan ke 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

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Pulang pergi

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 tertentu dari daftar editor untuk File. Metode ini tidak memblokir pengguna agar tidak 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, tindakan ini juga akan menghapus pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Pulang pergi

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 tertentu dari daftar editor untuk File. Metode ini tidak memblokir pengguna agar tidak 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, tindakan ini juga akan menghapus pengguna dari daftar pelihat.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Pulang pergi

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 penonton dan pemberi komentar untuk File. Metode ini tidak berpengaruh jika pengguna adalah editor, bukan penonton atau pemberi komentar. Metode ini juga tidak memblokir pengguna agar tidak mengakses File jika mereka termasuk dalam kelas 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, tindakan ini juga akan menghapus pengguna dari daftar editor.

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang akan dihapus.

Pulang pergi

File — File ini untuk pengaitan.

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 penonton dan pemberi komentar untuk File. Metode ini tidak berpengaruh jika pengguna adalah editor, bukan penonton. Metode ini juga tidak memblokir pengguna agar tidak mengakses File jika mereka termasuk dalam kelas 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, tindakan ini juga akan menghapus pengguna dari daftar editor.

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang akan dihapus.

Pulang pergi

File — File ini untuk pengaitan.

Otorisasi

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

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

revokePermissions(emailAddress)

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

Parameter

NamaJenisDeskripsi
emailAddressStringAlamat email pengguna yang aksesnya harus dicabut.

Pulang pergi

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)

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

Parameter

NamaJenisDeskripsi
userUserRepresentasi pengguna yang aksesnya harus dicabut.

Pulang pergi

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)

Menimpa konten file dengan penggantian tertentu. Menampilkan pengecualian jika content lebih besar dari 10 MB. 

// Creates a text file with the content 'Hello, world!'
const 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

NamaJenisDeskripsi
contentStringKonten baru untuk file.

Pulang pergi

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)

Menetapkan deskripsi untuk File.

Parameter

NamaJenisDeskripsi
descriptionStringdeskripsi baru untuk File

Pulang pergi

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

setName(name)

Menetapkan nama File.

Parameter

NamaJenisDeskripsi
nameStringnama baru File

Pulang pergi

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

setOwner(emailAddress)

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

Parameter

NamaJenisDeskripsi
emailAddressStringalamat email pengguna yang akan menjadi pemilik baru

Pulang pergi

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

setOwner(user)

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

Parameter

NamaJenisDeskripsi
userUserrepresentasi pengguna yang akan menjadi pemilik baru

Pulang pergi

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

setSecurityUpdateEnabled(enabled)

Menetapkan apakah File 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 File.

Pulang pergi

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

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

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

Pulang pergi

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 pengguna individu 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.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

Parameter

NamaJenisDeskripsi
accessTypeAccessclass pengguna yang dapat mengakses File
permissionTypePermissionizin yang harus diberikan kepada pengguna yang dapat mengakses File

Pulang pergi

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

setStarred(starred)

Menetapkan apakah File diberi bintang di Drive pengguna. Default untuk File baru adalah false.

Parameter

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

Pulang pergi

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

setTrashed(trashed)

Menetapkan apakah File ada di sampah Drive pengguna. Hanya pemilik yang dapat menghapus File. Default untuk File baru adalah false.

Parameter

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

Pulang pergi

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