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.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

Özellikler

ÖzellikTürAçıklama
AccessAccessAçıkça erişim izni verilen bireysel kullanıcıların yanı sıra bir dosyaya veya klasöre erişebilen kullanıcı sınıflarını temsil eden bir enum.
PermissionPermissionAçıkça erişim verilen bireysel 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 iterasyonun devam jetonundan yararlanarak dosya yinelemesini devam ettirir.
continueFolderIterator(continuationToken)FolderIteratorÖnceki bir yinelemeden devam jetonu 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çeriğe sahip bir metin dosyası oluşturur.
createFile(name, content, mimeType)FileKullanıcının Drive'ının kök dizininde belirtilen ada, içeriğe ve MIME türüne sahip bir dosya oluşturur.
createFolder(name)FolderKullanıcının Drive'ının kök dizininde belirtilen adla bir klasör oluşturur.
createShortcut(targetId)FileSağlanan Drive öğesi kimliğine kısayol oluşturur ve bu kimliği döndürür.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileSağlanan Drive öğesi kimliği ve kaynak anahtarı için 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 forceSingleParent davranışını etkinleştirir veya devre dışı bırakır.
getFileById(id)FileVerilen 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 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)FolderBelirtilen kimliğe sahip klasörü alır.
getFolderByIdAndResourceKey(id, resourceKey)FolderBelirtilen kimliğe ve kaynak anahtarına sahip klasörü alır.
getFolders()FolderIteratorKullanıcının Drive'ındaki tüm klasörlerin bir 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 dizinindeki 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 bir koleksiyonunu alır.
searchFiles(params)FileIteratorKullanıcının Drive'ında belirtilen arama ölçütleriyle eşleşen tüm dosyaların bir koleksiyonunu alır.
searchFolders(params)FolderIteratorKullanıcının Drive'ında belirtilen arama ölçütleriyle eşleşen tüm klasörlerin koleksiyonunu alır.

Ayrıntılı belgeler

continueFileIterator(continuationToken)

Önceki bir iterasyonun devam jetonundan yararlanarak dosya yinelemesini devam ettirir. Bir yürütmedeki iterasyonun işlenmesi maksimum yürütme süresini aşıyorsa bu yöntem yararlı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ünün devam jetonu.

Return

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


continueFolderIterator(continuationToken)

Önceki bir yinelemeden devam jetonu kullanarak klasör yinelemesini devam ettirir. Bir yürütmedeki iterasyonun işlenmesi maksimum yürütme süresini aşıyorsa bu yöntem yararlı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 bir devam jetonu.

Return

FolderIterator: Devam etme jetonu oluşturulduğunda önceki bir iterasyonda kalan klasörlerden oluşan bir koleksiyon.


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 dosyanın verileri.

Return

File: Yeni dosya.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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çeriğe sahip 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ı, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

createFile(name, content, mimeType)

Kullanıcının Drive'ının kök dizininde belirtilen ada, içeriğe ve MIME türüne sahip bir dosya oluşturur. content 10 MB'tan büyükse istisna oluşturur.

// 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 kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

createFolder(name)

Kullanıcının Drive'ının kök dizininde belirtilen adla 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 kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

createShortcut(targetId)

Sağlanan Drive öğesi kimliğine kısayol oluşturur ve bu kimliği 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 kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Sağlanan Drive öğesi kimliği ve kaynak anahtarı için kısayol oluşturur ve bu kısayolu döndürür. Kaynak anahtarı, bir 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ı, aşağıdaki kapsamların biri 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 forceSingleParent davranışını etkinleştirir veya devre dışı bırakır.

Daha fazla ayrıntı için Google Drive'ın klasör yapısını ve paylaşım modellerini basitleştirme blogunu inceleyin.

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

Parametreler

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

Yetkilendirme

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

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

getFileById(id)

Verilen kimliğe sahip dosyayı alır. Dosya yoksa veya kullanıcının dosyaya erişim izni yoksa bir 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ı, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

  • 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ı, bir bağlantı kullanılarak paylaşılan dosyalara erişmek için iletilmesi gereken ek bir parametredir.

Dosya yoksa veya kullanıcının dosyaya erişim izni yoksa bir 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ı, aşağıdaki kapsamların biri 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ın yer aldığı bir koleksiyondur.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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 yer aldığı koleksiyon.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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 belirtilen MIME türüne sahip tüm dosyaların yer aldığı koleksiyon.

Yetkilendirme

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

  • 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 yoksa veya kullanıcının klasöre erişim 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ı, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getFolderByIdAndResourceKey(id, resourceKey)

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

Klasör yoksa veya kullanıcının klasöre erişim 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ı, aşağıdaki kapsamların biri 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 bir koleksiyonunu alır.

Return

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

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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örleri içeren koleksiyondur.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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 dizinindeki 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 kapsamların biri 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 kapsamların biri 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 kapsamların biri 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 dosyalardan oluşan bir koleksiyondur.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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 bir 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örlerden oluşan bir koleksiyondur.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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 arama ölçütleriyle eşleşen tüm dosyaların bir koleksiyonunu alır. Arama ölçütlerinin ayrıntıları, Google Drive SDK'sı dokümanlarında açıklanmıştır. Drive hizmetinin, Drive API'nin v2 sürümünü kullandığını ve bazı sorgu alanlarının v3'ten farklı olduğunu unutmayın. v2 ile v3 arasındaki alan farklarını inceleyin.

params bağımsız değişkeni, dize değerleri içerebilen bir sorgu dizesidir. Bu nedenle, tırnak işaretlerini doğru şekilde kullanmaktan kaçının (ör. "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 bulunan ve arama ölçütleriyle eşleşen tüm dosyaların koleksiyonudur.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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 arama ölçütleriyle eşleşen tüm klasörlerin koleksiyonunu alır. Arama ölçütlerinin ayrıntıları, Google Drive SDK'sı dokümanlarında açıklanmıştır. Drive hizmetinin, Drive API'nin v2 sürümünü kullandığını ve bazı sorgu alanlarının v3'ten farklı olduğunu unutmayın. v2 ile v3 arasındaki alan farklarını inceleyin.

params bağımsız değişkeni, dize değerleri içerebilen bir sorgu dizesidir. Bu nedenle, tırnak işaretlerini doğru şekilde kullanmaktan kaçının (ör. "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 bulunan ve arama ölçütleriyle eşleşen tüm klasörleri içeren koleksiyon.

Yetkilendirme

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

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

Kullanımdan kaldırılan yöntemler