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. Ortak Drive'lardaki dosyalara veya klasörlere erişmek için gelişmiş Drive hizmetini kullanın. 

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

Özellikler

MülkTürAçıklama
AccessAccessBelirli bir dosyaya veya klasöre erişimi açıkça verilmiş kullanıcıların yanı sıra dosyaya ya da klasöre erişebilen kullanıcı sınıflarını temsil eden bir enum.
PermissionPermissionAçıkça erişim izni verilen kullanıcıların yanı sıra bir dosyaya veya klasöre erişebilen kullanıcılara verilen izinleri temsil eden bir enum.

Yöntemler

YöntemDönüş türüKısa açıklama
continueFileIterator(continuationToken)FileIteratorÖnceki bir iteratörden alınan devam ettirme jetonunu kullanarak dosya iterasyonunu devam ettirir.
continueFolderIterator(continuationToken)FolderIteratorÖnceki bir iteratörden alınan bir devam ettirme jetonunu kullanarak klasör iterasyonunu devam ettirir.
createFile(blob)FileBelirli bir Blob rastgele verisinden kullanıcının Drive'ının kökünde bir dosya oluşturur.
createFile(name, content)FileKullanıcının Drive'ının kökünde, belirtilen adı ve içeriği içeren bir metin dosyası oluşturur.
createFile(name, content, mimeType)FileKullanıcının Drive'ının kökünde, belirtilen adı, içeriği ve MIME türünü içeren bir dosya oluşturur.
createFolder(name)FolderKullanıcının Drive'ının kökünde, belirtilen ada sahip bir klasör oluşturur.
createShortcut(targetId)FileSağlanan Drive öğe kimliğinin kısayolunu oluşturur ve döndürür.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileSağlanan Drive öğe kimliğinin ve kaynak anahtarının kısayolunu oluşturup döndürür.
enforceSingleParent(value)voidÖğe ebeveynlerini etkileyen tüm çağrılar için enforceSingleParent davranışını etkinleştirir veya devre dışı bırakır.
getFileById(id)FileBelirtilen kimliğe sahip dosyayı alır.
getFileByIdAndResourceKey(id, resourceKey)FileBelirtilen kimliğe ve kaynak anahtarına sahip dosyayı alır.
getFiles()FileIteratorKullanıcının Drive'ındaki tüm dosyaların koleksiyonunu alır.
getFilesByName(name)FileIteratorKullanıcının Drive'ındaki, belirtilen ada sahip tüm dosyaların koleksiyonunu alır.
getFilesByType(mimeType)FileIteratorKullanıcının Drive'ındaki belirli bir MIME türüne sahip tüm dosyaların koleksiyonunu alır.
getFolderById(id)FolderBelirtilen kimliğe sahip klasörü alır.
getFolderByIdAndResourceKey(id, resourceKey)FolderBelirtilen kimlik 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'ındaki, belirtilen ada sahip tüm klasörlerin koleksiyonunu alır.
getRootFolder()FolderKullanıcının Drive'ının kökündeki klasörü alır.
getStorageLimit()IntegerKullanıcının Drive'da depolayabileceği bayt sayısını alır.
getStorageUsed()IntegerKullanıcının şu anda Drive'da depoladığı bayt sayısını alır.
getTrashedFiles()FileIteratorKullanıcının Drive'ındaki çöp kutusundaki tüm dosyaların koleksiyonunu alır.
getTrashedFolders()FolderIteratorKullanıcının Drive'ındaki çöp kutusundaki tüm klasörlerin koleksiyonunu alır.
searchFiles(params)FileIteratorKullanıcının Drive'ındaki, belirtilen arama ölçütleriyle eşleşen tüm dosyaların koleksiyonunu alır.
searchFolders(params)FolderIteratorKullanıcının Drive'ındaki, belirtilen arama ölçütleriyle eşleşen tüm klasörlerin koleksiyonunu alır.

Ayrıntılı dokümanlar

continueFileIterator(continuationToken)

Önceki bir iteratörden alınan devam ettirme jetonunu kullanarak dosya iterasyonunu devam ettirir. Bu yöntem, bir iteratör bir yürütme işleminde işlenirken maksimum yürütme süresini aşarsa faydalıdır. 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 iteratöründen gelen bir devam jetonu.

Return

FileIterator: Devam jetonu oluşturulduğunda önceki bir iteratörde kalan dosya koleksiyonu.

continueFolderIterator(continuationToken)

Önceki bir iteratörden alınan bir devam ettirme jetonunu kullanarak klasör iterasyonunu devam ettirir. Bu yöntem, bir iteratör bir yürütme işleminde işlenirken maksimum yürütme süresini aşarsa faydalıdır. 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 bir klasör iteratöründen gelen bir devam jetonu.

Return

FolderIterator: Devam jetonu oluşturulduğunda önceki bir iteratörde kalan klasör koleksiyonu.

createFile(blob)

Belirli bir Blob rastgele verisinden kullanıcının Drive'ının kökünde bir dosya oluşturur.

Parametreler

AdTürAçıklama
blobBlobSourceYeni dosyanın verileri.

Return

File: Yeni dosya.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

createFile(name, content)

Kullanıcının Drive'ının kökünde, belirtilen adı ve içeriği içeren bir metin dosyası oluşturur. content 50 MB'tan büyükse istisna atar. 

// 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

createFile(name, content, mimeType)

Kullanıcının Drive'ının kökünde, belirtilen adı, içeriği ve MIME türünü içeren bir dosya oluşturur. content 10 MB'tan büyükse istisna atar. 

// 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

createFolder(name)

Kullanıcının Drive'ının kökünde, belirtilen 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

createShortcut(targetId)

Sağlanan Drive öğe kimliğinin kısayolunu oluşturur ve 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Sağlanan Drive öğe kimliğinin ve kaynak anahtarının kısayolunu oluşturup döndürür. Kaynak anahtarı, bağlantı kullanılarak paylaşılan hedef dosyaya veya klasöre erişmek için iletilmesi gereken ek bir parametredir. 

// 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

enforceSingleParent(value)

Öğe ebeveynlerini etkileyen tüm çağrılar için enforceSingleParent davranışını etkinleştirir veya devre dışı bırakır.

Daha fazla bilgi için Google Drive'ın klasör yapısını ve paylaşım modellerini basitleştirme başlıklı blog makalesine bakın. 

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

Parametreler

AdTürAçıklama
valueBooleanenforceSingleParent işaretinin yeni durumu.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getFileById(id)

Belirtilen kimliğe sahip dosyayı alır. Dosya mevcut değilse veya kullanıcının dosyaya erişme izni yoksa komut dosyası istisnası oluşturur. 

// 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getFileByIdAndResourceKey(id, resourceKey)

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

Dosya mevcut değilse veya kullanıcının dosyaya erişme izni yoksa komut dosyası istisnası oluşturur. 

// 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getFiles()

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

Return

FileIterator: Kullanıcının Drive'ındaki tüm dosyaların koleksiyonu.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getFilesByName(name)

Kullanıcının Drive'ındaki, belirtilen ada sahip tüm dosyaların 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getFilesByType(mimeType)

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

Parametreler

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

Return

FileIterator: Kullanıcının Drive'ındaki, belirli bir MIME türüne sahip tüm dosyaların koleksiyonudur.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getFolderById(id)

Belirtilen kimliğe sahip klasörü alır. Klasör mevcut değilse veya kullanıcının klasöre erişme izni yoksa komut dosyası istisnası oluşturur.

Parametreler

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

Return

Folder: Belirtilen kimliğe sahip klasör.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getFolderByIdAndResourceKey(id, resourceKey)

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

Klasör mevcut değilse veya kullanıcının klasöre erişme izni yoksa komut dosyası istisnası oluşturur.

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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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 bir koleksiyonu.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getFoldersByName(name)

Kullanıcının Drive'ındaki, 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'ındaki, belirtilen ada sahip tüm klasörlerin koleksiyonu.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getRootFolder()

Kullanıcının Drive'ının kökündeki 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getStorageLimit()

Kullanıcının Drive'da depolayabileceği 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 depolayabileceği bayt sayısı.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getStorageUsed()

Kullanıcının şu anda 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 şu anda Drive'da depoladığı bayt sayısı.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getTrashedFiles()

Kullanıcının Drive'ındaki çöp kutusundaki tüm dosyaların 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 koleksiyonudur.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getTrashedFolders()

Kullanıcının Drive'ındaki çö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örlerin koleksiyonu.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

searchFiles(params)

Kullanıcının Drive'ındaki, belirtilen arama ölçütleriyle eşleşen tüm dosyaların koleksiyonunu alır. Arama ölçütleri Google Drive SDK dokümanlarında ayrıntılı olarak açıklanmıştır. Drive hizmetinin Drive API'nin 2. sürümünü kullandığını ve bazı sorgu alanlarının 3. sürümden farklı olduğunu unutmayın. v2 ile v3 arasındaki alan farklılıklarını inceleyin.

params bağımsız değişkeni, dize değerleri içerebilen bir sorgu dizesi olduğundan tırnak işaretlerini doğru şekilde kod dışına çıkardığınızdan emin olun (ö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.""
const files = DriveApp.searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

Parametreler

AdTürAçıklama
paramsStringGoogle Drive SDK dokümanlarında açıklandığı gibi arama ölçütleri.

Return

FileIterator: Kullanıcının Drive'ındaki, arama ölçütleriyle eşleşen tüm dosyaların koleksiyonu.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

searchFolders(params)

Kullanıcının Drive'ındaki, belirtilen arama ölçütleriyle eşleşen tüm klasörlerin koleksiyonunu alır. Arama ölçütleri Google Drive SDK dokümanlarında ayrıntılı olarak açıklanmıştır. Drive hizmetinin Drive API'nin 2. sürümünü kullandığını ve bazı sorgu alanlarının 3. sürümden farklı olduğunu unutmayın. v2 ile v3 arasındaki alan farklılıklarını inceleyin.

params bağımsız değişkeni, dize değerleri içerebilen bir sorgu dizesi olduğundan tırnak işaretlerini doğru şekilde kod dışına çıkardığınızdan emin olun (ö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.
const folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

Parametreler

AdTürAçıklama
paramsStringGoogle Drive SDK dokümanlarında açıklandığı gibi arama ölçütleri.

Return

FolderIterator: Kullanıcının Drive'ındaki, arama ölçütleriyle eşleşen tüm klasörlerin koleksiyonu.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

Kullanımdan kaldırılan yöntemler