Class DriveApp

DriveApp

Komut dosyalarının Google Drive'da dosya ve klasör oluşturmasına, bulmasına ve değiştirmesine izin verir. Dosyalara erişmek için veya gelişmiş Drive hizmetini kullanın. 

// Logs the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

Özellikler

ÖzellikTürAçıklama
AccessAccessHerhangi bir şahıs dışında dosya veya klasöre erişebilen kullanıcı sınıflarını temsil eden bir sıralama Açıkça erişim verilen kullanıcılar
PermissionPermissionBir dosya veya klasöre erişebilen kullanıcılara verilen izinleri temsil eden bir sıralama açıkça erişim verilen tüm bireysel kullanıcılar.

Yöntemler

YöntemDönüş türüKısa açıklama
continueFileIterator(continuationToken)FileIteratorÖnceki bir iteratörden gelen devamlılık jetonunu kullanarak dosya yinelemesini devam ettirir.
continueFolderIterator(continuationToken)FolderIteratorÖnceki bir iteratörün devamlılık jetonunu kullanarak klasör yinelemesini devam ettirir.
createFile(blob)FileBelirli bir Blob rastgele veriden kullanıcının Drive'ının kök dizininde bir dosya oluşturur.
createFile(name, content)FileKullanıcının Drive'ının kök dizininde belirtilen ad ve içerikle bir metin dosyası oluşturur.
createFile(name, content, mimeType)FileBelirtilen ad, içerik ve MIME türüne sahip kullanıcının Drive'ının kök dizininde bir dosya oluşturur.
createFolder(name)FolderKullanıcının Drive'ının kök dizininde verilen ada sahip bir klasör oluşturur.
createShortcut(targetId)FileSağlanan Drive öğe kimliğine kısayol oluşturur ve bunu döndürür.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileSağlanan Drive öğe kimliği ve kaynak anahtarına kısayol oluşturur ve bu kısayolu döndürür.
enforceSingleParent(value)voidÖğe üst öğelerini etkileyen tüm çağrılar için tekli ebeveyn davranışını zorunlu kılar veya devre dışı bırakır.
getFileById(id)FileVerilen kimliğe sahip dosyayı alır.
getFileByIdAndResourceKey(id, resourceKey)FileVerilen kimliğe ve kaynak anahtarına sahip dosyayı alır.
getFiles()FileIteratorKullanıcının Drive'ındaki tüm dosyaların bir koleksiyonunu alır.
getFilesByName(name)FileIteratorKullanıcının Drive'ında belirtilen ada sahip tüm dosyaların bir koleksiyonunu alır.
getFilesByType(mimeType)FileIteratorKullanıcının Drive'ında belirtilen MIME türüne sahip tüm dosyaların bir koleksiyonunu alır.
getFolderById(id)FolderVerilen kimliğe sahip klasörü alır.
getFolderByIdAndResourceKey(id, resourceKey)FolderVerilen kimliğe ve kaynak anahtarına sahip klasörü alır.
getFolders()FolderIteratorKullanıcının Drive'ındaki tüm klasörlerin koleksiyonunu alır.
getFoldersByName(name)FolderIteratorKullanıcının Drive'ında belirtilen ada sahip tüm klasörlerin koleksiyonunu alır.
getRootFolder()FolderKullanıcının Drive'ının kök dizininde bulunan klasörü alır.
getStorageLimit()IntegerKullanıcının Drive'da depolamasına izin verilen bayt sayısını alır.
getStorageUsed()IntegerKullanıcının Drive'da depoladığı bayt sayısını alır.
getTrashedFiles()FileIteratorKullanıcının Drive'ının çöp kutusundaki tüm dosyaların bir koleksiyonunu alır.
getTrashedFolders()FolderIteratorKullanıcının Drive'ının çöp kutusundaki tüm klasörlerin koleksiyonunu alır.
searchFiles(params)FileIteratorKullanıcının Drive'ında, belirtilen aramayla eşleşen tüm dosyaların bir koleksiyonunu alır ölçütlerine bağlıdır.
searchFolders(params)FolderIteratorKullanıcının Drive'ında, belirtilen aramayla eşleşen tüm klasörlerin koleksiyonunu alır ölçütlerine bağlıdır.

Ayrıntılı belgeler

continueFileIterator(continuationToken)

Önceki bir iteratörden gelen devamlılık jetonunu kullanarak dosya yinelemesini devam ettirir. Bu yöntem Bir yürütmede yinelemenin işlenmesi maksimum yürütme süresini aşarsa yararlı olur. Devam jetonları genellikle bir hafta boyunca geçerlidir. 

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

Parametreler

AdTürAçıklama
continuationTokenStringÖnceki bir dosya yinelemesinden bir devam jetonu.

Return

FileIterator: Devamlılık jetonu alındığında önceki bir yinelemede kalan dosya koleksiyonu oluşturuldu.

continueFolderIterator(continuationToken)

Önceki bir iteratörün devamlılık jetonunu kullanarak klasör yinelemesini devam ettirir. Bu yöntem Bir yürütmede yinelemenin işlenmesi maksimum yürütme süresini aşarsa yararlı olur. Devam jetonları genellikle bir hafta boyunca geçerlidir. 

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

Parametreler

AdTürAçıklama
continuationTokenStringÖnceki klasör yineleyiciden bir devam jetonu.

Return

FolderIterator: Geçiş sırasında önceki yinelemede kalan klasörlerden oluşan bir koleksiyon jeton oluşturuldu.

createFile(blob)

Belirli bir Blob rastgele veriden kullanıcının Drive'ının kök dizininde bir dosya oluşturur. 

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.createFile(blob);

Parametreler

AdTürAçıklama
blobBlobSourceYeni dosyaya ilişkin veriler.

Return

File - Yeni dosya.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

createFile(name, content)

Kullanıcının Drive'ının kök dizininde belirtilen ad ve içerikle bir metin dosyası oluşturur. Şunu atar: (content) 50 MB'tan büyükse istisna uygular. 

// Create a text file with the content "Hello, world!"
DriveApp.createFile('New Text File', 'Hello, world!');

Parametreler

AdTürAçıklama
nameStringYeni dosyanın adı.
contentStringYeni dosyanın içeriği.

Return

File - Yeni dosya.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

createFile(name, content, mimeType)

Belirtilen ad, içerik ve MIME türüne sahip kullanıcının Drive'ının kök dizininde bir dosya oluşturur. Fırlatma content 10 MB'tan büyükse istisna uygulanır. 

// Create an HTML file with the content "Hello, world!"
DriveApp.createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

Parametreler

AdTürAçıklama
nameStringYeni dosyanın adı.
contentStringYeni dosyanın içeriği.
mimeTypeStringYeni dosyanın MIME türü.

Return

File - Yeni dosya.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

createFolder(name)

Kullanıcının Drive'ının kök dizininde verilen ada sahip bir klasör oluşturur.

Parametreler

AdTürAçıklama
nameStringYeni klasörün adı.

Return

Folder — Yeni klasör.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

createShortcut(targetId)

Sağlanan Drive öğe kimliğine kısayol oluşturur ve bunu döndürür.

Parametreler

AdTürAçıklama
targetIdStringHedef dosyanın veya klasörün dosya kimliği.

Return

File: Yeni kısayol.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Sağlanan Drive öğe kimliği ve kaynak anahtarına kısayol oluşturur ve bu kısayolu döndürür. Kaynak anahtarı, etkinleştirilecek hedef dosyaya veya klasöre erişmek için iletilmesi gereken bir bağlantı kullanılarak paylaşıldı. 

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

Parametreler

AdTürAçıklama
targetIdStringHedef dosyanın veya klasörün kimliği.
targetResourceKeyStringHedef dosyanın veya klasörün kaynak anahtarı.

Return

File: Yeni kısayol.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

enforceSingleParent(value)

Öğe üst öğelerini etkileyen tüm çağrılar için tekli ebeveyn davranışını zorunlu kılar veya devre dışı bırakır.

Ayrıntılı bilgi için Google Drive'ın klasör yapısını ve paylaşım modellerini basitleştirme başlıklı blog yazısına göz atın. inceleyebilirsiniz. 

// Enables enforceSingleParent behavior for all calls affecting item parents.
DriveApp.enforceSingleParent(true);

Parametreler

AdTürAçıklama
valueBooleanforceSingleParent işaretinin yeni durumudur.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getFileById(id)

Verilen kimliğe sahip dosyayı alır. Dosya mevcut değilse veya kullanıcısının erişim izni yok. 

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

Parametreler

AdTürAçıklama
idStringDosyanın kimliği.

Return

File — Belirtilen kimliğe sahip dosya.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getFileByIdAndResourceKey(id, resourceKey)

Verilen kimliğe ve kaynak anahtarına sahip dosyayı alır. Kaynak anahtarları ek bir parametredir Bir bağlantı kullanılarak paylaşılan dosyalara erişmek için iletilmesi gereken

Dosya mevcut değilse veya kullanıcının izni yoksa komut dosyası istisnası atar erişebilir. 

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

Parametreler

AdTürAçıklama
idStringDosyanın kimliği.
resourceKeyStringKlasörün kaynak anahtarı.

Return

File — Belirtilen kimliğe sahip dosya.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getFiles()

Kullanıcının Drive'ındaki tüm dosyaların bir koleksiyonunu alır.

Return

FileIterator — Kullanıcının Drive'ındaki tüm dosyaları içeren bir koleksiyon.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getFilesByName(name)

Kullanıcının Drive'ında belirtilen ada sahip tüm dosyaların bir koleksiyonunu alır.

Parametreler

AdTürAçıklama
nameStringBulunacak dosyaların adı.

Return

FileIterator — Kullanıcının Drive'ında belirtilen ada sahip tüm dosyaların koleksiyonu.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getFilesByType(mimeType)

Kullanıcının Drive'ında belirtilen MIME türüne sahip tüm dosyaların bir koleksiyonunu alır.

Parametreler

AdTürAçıklama
mimeTypeStringBulunacak dosyaların MIME türü.

Return

FileIterator: Kullanıcının Drive'ında, belirli bir MIME'ye sahip olan tüm dosyaların koleksiyonu türü.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getFolderById(id)

Verilen kimliğe sahip klasörü alır. Klasör yoksa veya Kullanıcının erişim izni yok.

Parametreler

AdTürAçıklama
idStringKlasörün kimliği.

Return

Folder — Belirtilen kimliğe sahip klasör.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getFolderByIdAndResourceKey(id, resourceKey)

Verilen kimliğe ve kaynak anahtarına sahip klasörü alır. Kaynak anahtarları ek bir parametredir Bir bağlantı kullanılarak paylaşılan klasörlere erişmek için iletilmesi gereken

Klasör yoksa veya kullanıcının izni yoksa komut dosyası istisnası atar erişebilir.

Parametreler

AdTürAçıklama
idStringKlasörün kimliği.
resourceKeyStringKlasörün kaynak anahtarı.

Return

Folder — Belirtilen kimliğe sahip klasör.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getFolders()

Kullanıcının Drive'ındaki tüm klasörlerin koleksiyonunu alır.

Return

FolderIterator: Kullanıcının Drive'ındaki tüm klasörlerin koleksiyonu.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getFoldersByName(name)

Kullanıcının Drive'ında belirtilen ada sahip tüm klasörlerin koleksiyonunu alır.

Parametreler

AdTürAçıklama
nameStringBulunacak klasörlerin adı.

Return

FolderIterator — Kullanıcının Drive'ında belirtilen ada sahip tüm klasörlerin koleksiyonudur.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getRootFolder()

Kullanıcının Drive'ının kök dizininde bulunan klasörü alır. 

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

Return

Folder: Kullanıcının Drive'ının kök klasörü.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getStorageLimit()

Kullanıcının Drive'da depolamasına izin verilen bayt sayısını alır. 

// Gets the number of bytes the user can store in Drive and logs it to the console.
console.log(DriveApp.getStorageLimit());

Return

Integer: Kullanıcının Drive'da depolamasına izin verilen bayt sayısı.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getStorageUsed()

Kullanıcının Drive'da depoladığı bayt sayısını alır. 

// Gets the number of bytes the user is currently storing in Drive and logs it to the console.
console.log(DriveApp.getStorageUsed());

Return

Integer - Kullanıcının Drive'da depoladığı bayt sayısı.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getTrashedFiles()

Kullanıcının Drive'ının çöp kutusundaki tüm dosyaların bir koleksiyonunu alır. 

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

Return

FileIterator — Çöp kutusundaki dosya koleksiyonu.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

getTrashedFolders()

Kullanıcının Drive'ının çöp kutusundaki tüm klasörlerin koleksiyonunu alır. 

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

Return

FolderIterator: Çöp kutusundaki klasör koleksiyonu.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

searchFiles(params)

Kullanıcının Drive'ında, belirtilen aramayla eşleşen tüm dosyaların bir koleksiyonunu alır ölçütlerine bağlıdır. Arama ölçütleri, Google Drive SDK'sı dokümanlarında ayrıntılı olarak açıklanmıştır. Drive'ın hizmeti, Drive API'nin v2 sürümünü kullanır ve bazı sorgu alanları v3'ten farklıdır. Alanını inceleyin v2 ile v3 arasındaki farklar hakkında daha fazla bilgi edinin.

params bağımsız değişkeni, dize değerleri içerebilen bir sorgu dizesi olduğundan kullanabilirsiniz (örneğin, "title contains 'Gulliver\\'s Travels'" veya '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.""
var files = DriveApp.searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

Parametreler

AdTürAçıklama
paramsStringGoogle Drive SDK'sı dokümanlarında ayrıntılı olarak açıklanan arama ölçütleri.

Return

FileIterator - Kullanıcının Drive'ında, aramayla eşleşen tüm dosyaların koleksiyonu ölçütlerine bağlıdır.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

searchFolders(params)

Kullanıcının Drive'ında, belirtilen aramayla eşleşen tüm klasörlerin koleksiyonunu alır ölçütlerine bağlıdır. Arama ölçütleri, Google Drive SDK'sı dokümanlarında ayrıntılı olarak açıklanmıştır. Drive'ın hizmeti, Drive API'nin v2 sürümünü kullanır ve bazı sorgu alanları v3'ten farklıdır. Alanını inceleyin v2 ile v3 arasındaki farklar hakkında daha fazla bilgi edinin.

params bağımsız değişkeni, dize değerleri içerebilen bir sorgu dizesi olduğundan kullanabilirsiniz (örneğin, "title contains 'Gulliver\\'s Travels'" veya 'title contains "Gulliver\'s Travels"'). 

// Logs the name of every folder in the user's Drive that you own and is starred.
var folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  console.log(folder.getName());
}

Parametreler

AdTürAçıklama
paramsStringGoogle Drive SDK'sı dokümanlarında ayrıntılı olarak açıklanan arama ölçütleri.

Return

FolderIterator - Kullanıcının Drive'ında, aramayla eşleşen tüm klasörlerin koleksiyonu ölçütlerine bağlıdır.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

Desteği sonlandırılan yöntemler