Mengizinkan skrip membuat, menemukan, dan mengubah file dan folder di Google Drive. Untuk mengakses file atau folder di drive bersama, gunakan layanan Drive lanjutan.
// Logs the name of every file in the user's Drive. const files = DriveApp.getFiles(); while (files.hasNext()) { const file = files.next(); console.log(file.getName()); }
Properti
Properti | Jenis | Deskripsi |
---|---|---|
Access | Access | Enum yang mewakili class pengguna yang dapat mengakses file atau folder, selain pengguna individu yang telah diberi akses secara eksplisit. |
Permission | Permission | Enum yang mewakili izin yang diberikan kepada pengguna yang dapat mengakses file atau folder, selain setiap pengguna individu yang telah diberi akses secara eksplisit. |
Metode
Metode | Jenis hasil yang ditampilkan | Deskripsi singkat |
---|---|---|
continue | File | Melanjutkan iterasi file menggunakan token lanjutan dari iterator sebelumnya. |
continue | Folder | Melanjutkan iterasi folder menggunakan token lanjutan dari iterator sebelumnya. |
create | File | Membuat file di root Drive pengguna dari Blob data arbitrer tertentu. |
create | File | Membuat file teks di root Drive pengguna dengan nama dan konten yang diberikan. |
create | File | Membuat file di root Drive pengguna dengan nama, konten, dan jenis MIME yang diberikan. |
create | Folder | Membuat folder di root Drive pengguna dengan nama yang diberikan. |
create | File | Membuat pintasan ke ID item Drive yang disediakan, dan menampilkannya. |
create | File | Membuat pintasan ke ID item Drive dan kunci resource yang diberikan, lalu menampilkannya. |
enforce | void | Mengaktifkan atau menonaktifkan perilaku enforceSingleParent untuk semua panggilan yang memengaruhi induk item. |
get | File | Mendapatkan file dengan ID yang diberikan. |
get | File | Mendapatkan file dengan ID dan kunci resource yang diberikan. |
get | File | Mendapatkan koleksi semua file di Drive pengguna. |
get | File | Mendapatkan koleksi semua file di Drive pengguna yang memiliki nama yang diberikan. |
get | File | Mendapatkan koleksi semua file di Drive pengguna yang memiliki jenis MIME tertentu. |
get | Folder | Mendapatkan folder dengan ID yang diberikan. |
get | Folder | Mendapatkan folder dengan ID dan kunci resource yang diberikan. |
get | Folder | Mendapatkan kumpulan semua folder di Drive pengguna. |
get | Folder | Mendapatkan kumpulan semua folder di Drive pengguna yang memiliki nama yang diberikan. |
get | Folder | Mendapatkan folder di root Drive pengguna. |
get | Integer | Mendapatkan jumlah byte yang diizinkan untuk disimpan pengguna di Drive. |
get | Integer | Mendapatkan jumlah byte yang saat ini disimpan pengguna di Drive. |
get | File | Mendapatkan kumpulan semua file di sampah Drive pengguna. |
get | Folder | Mendapatkan kumpulan semua folder di sampah Drive pengguna. |
search | File | Mendapatkan kumpulan semua file di Drive pengguna yang cocok dengan kriteria penelusuran yang diberikan. |
search | Folder | Mendapatkan kumpulan semua folder di Drive pengguna yang cocok dengan kriteria penelusuran yang diberikan. |
Dokumentasi mendetail
continue File Iterator(continuationToken)
Melanjutkan iterasi file menggunakan token lanjutan dari iterator sebelumnya. Metode ini berguna jika pemrosesan iterator dalam satu eksekusi melebihi waktu eksekusi maksimum. Token lanjutan umumnya berlaku selama satu minggu.
// Continues getting a list of all 'Untitled document' files in the user's // Drive. Creates a file iterator named 'previousIterator'. const previousIterator = DriveApp.getFilesByName('Untitled document'); // Gets continuation token from the previous file iterator. const continuationToken = previousIterator.getContinuationToken(); // Creates a new iterator using the continuation token from the previous file // iterator. const newIterator = DriveApp.continueFileIterator(continuationToken); // Resumes the file iteration using a continuation token from 'firstIterator' // and logs the file name. if (newIterator.hasNext()) { const file = newIterator.next(); console.log(file.getName()); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
continuation | String | Token lanjutan dari iterator file sebelumnya. |
Pulang pergi
File
— Kumpulan file yang tetap ada di iterator sebelumnya saat token kelanjutan
dihasilkan.
continue Folder Iterator(continuationToken)
Melanjutkan iterasi folder menggunakan token lanjutan dari iterator sebelumnya. Metode ini berguna jika pemrosesan iterator dalam satu eksekusi melebihi waktu eksekusi maksimum. Token lanjutan umumnya berlaku selama satu minggu.
// Continues getting a list of all folders in user's Drive. // Creates a folder iterator named 'previousIterator'. const previousIterator = DriveApp.getFolders(); // Gets continuation token from the previous folder iterator. const continuationToken = previousIterator.getContinuationToken(); // Creates a new iterator using the continuation token from the previous folder // iterator. const newIterator = DriveApp.continueFolderIterator(continuationToken); // Resumes the folder iteration using a continuation token from the previous // iterator and logs the folder name. if (newIterator.hasNext()) { const folder = newIterator.next(); console.log(folder.getName()); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
continuation | String | Token lanjutan dari iterator folder sebelumnya. |
Pulang pergi
Folder
— Kumpulan folder yang tetap ada di iterator sebelumnya saat token
lanjutan dibuat.
create File(blob)
Membuat file di root Drive pengguna dari Blob
data arbitrer tertentu.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
blob | Blob | Data untuk file baru. |
Pulang pergi
File
— File baru.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
create File(name, content)
Membuat file teks di root Drive pengguna dengan nama dan konten yang diberikan. Menampilkan pengecualian jika content
lebih besar dari 50 MB.
// Create a text file with the content "Hello, world!" DriveApp.createFile('New Text File', 'Hello, world!');
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
name | String | Nama file baru. |
content | String | Konten untuk file baru. |
Pulang pergi
File
— File baru.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
create File(name, content, mimeType)
Membuat file di root Drive pengguna dengan nama, konten, dan jenis MIME yang diberikan. Menampilkan
pengecualian jika content
lebih besar dari 10 MB.
// Create an HTML file with the content "Hello, world!" DriveApp.createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
name | String | Nama file baru. |
content | String | Konten untuk file baru. |
mime | String | Jenis MIME file baru. |
Pulang pergi
File
— File baru.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
create Folder(name)
Membuat folder di root Drive pengguna dengan nama yang diberikan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
name | String | Nama folder baru. |
Pulang pergi
Folder
— Folder baru.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
create Shortcut(targetId)
Membuat pintasan ke ID item Drive yang disediakan, dan menampilkannya.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
target | String | ID file dari file atau folder target. |
Pulang pergi
File
— Pintasan baru.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
create Shortcut For Target Id And Resource Key(targetId, targetResourceKey)
Membuat pintasan ke ID item Drive dan kunci resource yang diberikan, lalu menampilkannya. Kunci resource adalah parameter tambahan yang perlu diteruskan untuk mengakses file atau folder target yang telah dibagikan menggunakan link.
// Creates shortcuts for all folders in the user's drive that have a specific // name. // TODO(developer): Replace 'Test-Folder' with a valid folder name in your // drive. const folders = DriveApp.getFoldersByName('Test-Folder'); // Iterates through all folders named 'Test-Folder'. while (folders.hasNext()) { const folder = folders.next(); // Creates a shortcut to the provided Drive item ID and resource key, and // returns it. DriveApp.createShortcutForTargetIdAndResourceKey( folder.getId(), folder.getResourceKey(), ); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
target | String | ID file atau folder target. |
target | String | Kunci resource file atau folder target. |
Pulang pergi
File
— Pintasan baru.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
enforce Single Parent(value)
Mengaktifkan atau menonaktifkan perilaku enforceSingleParent untuk semua panggilan yang memengaruhi induk item.
Lihat blog Menyederhanakan struktur folder dan model berbagi Google Drive untuk mengetahui detail selengkapnya.
// Enables enforceSingleParent behavior for all calls affecting item parents. DriveApp.enforceSingleParent(true);
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
value | Boolean | Status baru tanda enforceSingleParent. |
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive
get File By Id(id)
Mendapatkan file dengan ID yang diberikan. Menampilkan pengecualian pembuatan skrip jika file tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace 'Test' with your file name. const files = DriveApp.getFilesByName('Test'); if (files.hasNext()) { // Gets the ID of each file in the list. const fileId = files.next().getId(); // Gets the file name using its ID and logs it to the console. console.log(DriveApp.getFileById(fileId).getName()); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
id | String | ID file. |
Pulang pergi
File
— File dengan ID yang diberikan.
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
get File By Id And Resource Key(id, resourceKey)
Mendapatkan file dengan ID dan kunci resource yang diberikan. Kunci resource adalah parameter tambahan yang perlu diteruskan untuk mengakses file yang telah dibagikan menggunakan link.
Menampilkan pengecualian pembuatan skrip jika file tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.
// Gets a list of all files in Drive with the given name. // TODO(developer): Replace 'Test' with your file name. const files = DriveApp.getFilesByName('Test'); if (files.hasNext()) { // Gets the first file in the list. const file = files.next(); // Gets the ID and resource key. const key = file.getResourceKey(); const id = file.getId(); // Logs the file name to the console using its ID and resource key. console.log(DriveApp.getFileByIdAndResourceKey(id, key).getName()); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
id | String | ID file. |
resource | String | Kunci resource folder. |
Pulang pergi
File
— File dengan ID yang diberikan.
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
get Files()
Mendapatkan koleksi semua file di Drive pengguna.
Pulang pergi
File
— Kumpulan semua file di Drive 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
get Files By Name(name)
Mendapatkan koleksi semua file di Drive pengguna yang memiliki nama yang diberikan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
name | String | Nama file yang akan ditemukan. |
Pulang pergi
File
— Kumpulan semua file di Drive pengguna yang memiliki nama yang diberikan.
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
get Files By Type(mimeType)
Mendapatkan koleksi semua file di Drive pengguna yang memiliki jenis MIME tertentu.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
mime | String | Jenis MIME file yang akan ditemukan. |
Pulang pergi
File
— Kumpulan semua file di Drive pengguna yang memiliki jenis MIME
tertentu.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
get Folder By Id(id)
Mendapatkan folder dengan ID yang diberikan. Menampilkan pengecualian pembuatan skrip jika folder tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
id | String | ID folder. |
Pulang pergi
Folder
— Folder dengan ID yang diberikan.
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
get Folder By Id And Resource Key(id, resourceKey)
Mendapatkan folder dengan ID dan kunci resource yang diberikan. Kunci resource adalah parameter tambahan yang perlu diteruskan untuk mengakses folder yang telah dibagikan menggunakan link.
Menampilkan pengecualian skrip jika folder tidak ada atau pengguna tidak memiliki izin untuk mengaksesnya.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
id | String | ID folder. |
resource | String | Kunci resource folder. |
Pulang pergi
Folder
— Folder dengan ID yang diberikan.
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
get Folders()
Mendapatkan kumpulan semua folder di Drive pengguna.
Pulang pergi
Folder
— Kumpulan semua folder di Drive 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
get Folders By Name(name)
Mendapatkan kumpulan semua folder di Drive pengguna yang memiliki nama yang diberikan.
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
name | String | Nama folder yang akan ditemukan. |
Pulang pergi
Folder
— Kumpulan semua folder di Drive pengguna yang memiliki nama yang diberikan.
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
get Root Folder()
Mendapatkan folder di root Drive pengguna.
// Gets the user's My Drive folder and logs its name to the console. console.log(DriveApp.getRootFolder().getName()); // Logs the Drive owner's name to the console. console.log(DriveApp.getRootFolder().getOwner().getName());
Pulang pergi
Folder
— Folder root Drive 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
get Storage Limit()
Mendapatkan jumlah byte yang diizinkan untuk disimpan pengguna di Drive.
// Gets the number of bytes the user can store in Drive and logs it to the // console. console.log(DriveApp.getStorageLimit());
Pulang pergi
Integer
— Jumlah byte yang diizinkan untuk disimpan pengguna 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
get Storage Used()
Mendapatkan jumlah byte yang saat ini disimpan pengguna di Drive.
// Gets the number of bytes the user is currently storing in Drive and logs it // to the console. console.log(DriveApp.getStorageUsed());
Pulang pergi
Integer
— Jumlah byte yang saat ini disimpan pengguna 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
get Trashed Files()
Mendapatkan kumpulan semua file di sampah Drive pengguna.
// Gets a list of all the files in the trash of the user's Drive. const trashFiles = DriveApp.getTrashedFiles(); // Logs the trash file names to the console. while (trashFiles.hasNext()) { const file = trashFiles.next(); console.log(file.getName()); }
Pulang pergi
File
— Kumpulan file di sampah.
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
get Trashed Folders()
Mendapatkan kumpulan semua folder di sampah Drive pengguna.
// Gets a collection of all the folders in the trash of the user's Drive. const trashFolders = DriveApp.getTrashedFolders(); // Logs the trash folder names to the console. while (trashFolders.hasNext()) { const folder = trashFolders.next(); console.log(folder.getName()); }
Pulang pergi
Folder
— Kumpulan folder di sampah.
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
search Files(params)
Mendapatkan kumpulan semua file di Drive pengguna yang cocok dengan kriteria penelusuran yang diberikan. Kriteria penelusuran dijelaskan dalam dokumentasi Google Drive SDK. Perhatikan bahwa layanan Drive menggunakan Drive API v2 dan beberapa kolom kueri berbeda dengan v3. Tinjau perbedaan kolom antara v2 dan v3.
Argumen params
adalah string kueri yang dapat berisi nilai string, jadi berhati-hatilah
untuk meng-escape tanda kutip dengan benar (misalnya "title contains 'Gulliver\\'s
Travels'"
atau 'title contains "Gulliver\'s Travels"'
).
// Logs the name of every file in the user's Drive that modified after February 28, // 2022 whose name contains "untitled."" const files = DriveApp.searchFiles( 'modifiedDate > "2022-02-28" and title contains "untitled"'); while (files.hasNext()) { const file = files.next(); console.log(file.getName()); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
params | String | Kriteria penelusuran, seperti yang dijelaskan dalam dokumentasi Google Drive SDK. |
Pulang pergi
File
— Kumpulan semua file di Drive pengguna yang cocok dengan kriteria penelusuran.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
search Folders(params)
Mendapatkan kumpulan semua folder di Drive pengguna yang cocok dengan kriteria penelusuran yang diberikan. Kriteria penelusuran dijelaskan dalam dokumentasi Google Drive SDK. Perhatikan bahwa layanan Drive menggunakan Drive API v2 dan beberapa kolom kueri berbeda dengan v3. Tinjau perbedaan kolom antara v2 dan v3.
Argumen params
adalah string kueri yang dapat berisi nilai string, jadi berhati-hatilah
untuk meng-escape tanda kutip dengan benar (misalnya "title contains 'Gulliver\\'s
Travels'"
atau 'title contains "Gulliver\'s Travels"'
).
// Logs the name of every folder in the user's Drive that you own and is starred. const folders = DriveApp.searchFolders('starred = true and "me" in owners'); while (folders.hasNext()) { const folder = folders.next(); console.log(folder.getName()); }
Parameter
Nama | Jenis | Deskripsi |
---|---|---|
params | String | Kriteria penelusuran, seperti yang dijelaskan dalam dokumentasi Google Drive SDK. |
Pulang pergi
Folder
— Kumpulan semua folder di Drive pengguna yang cocok dengan kriteria penelusuran.
Otorisasi
Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive