Class DriveApp

DriveApp

Umożliwia skryptom tworzenie, znajdowanie oraz modyfikowanie plików i folderów na Dysku Google. Aby uzyskać dostęp do plików i folderów na dyskach współdzielonych, użyj zaawansowanej usługi Dysku.

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

Właściwości

WłaściwośćTypOpis
AccessAccessWyliczenie reprezentujące klasy użytkowników, którzy mają dostęp do pliku lub folderu, oprócz wszystkich użytkowników, którym przyznano dostęp wprost.
PermissionPermissionWyliczenie reprezentujące uprawnienia przyznane użytkownikom, którzy mają dostęp do pliku lub folderu, oprócz użytkowników, którym jawnie przyznano dostęp.

Metody

MetodaZwracany typKrótki opis
continueFileIterator(continuationToken)FileIteratorWznawia iterację pliku przy użyciu tokena kontynuacji z poprzedniego iteratora.
continueFolderIterator(continuationToken)FolderIteratorWznawia iterację folderu przy użyciu tokena kontynuacji z poprzedniego iteratora.
createFile(blob)FileTworzy plik w katalogu głównym Dysku użytkownika na podstawie Blob dowolnych danych.
createFile(name, content)FileTworzy w katalogu głównym Dysku użytkownika plik tekstowy o podanej nazwie i treści.
createFile(name, content, mimeType)FileW katalogu głównym Dysku użytkownika tworzy plik o podanej nazwie, treści i typie MIME.
createFolder(name)FolderTworzy folder o podanej nazwie w katalogu głównym Dysku użytkownika.
createShortcut(targetId)FileTworzy skrót do podanego identyfikatora elementu na Dysku, a następnie go zwraca.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTworzy skrót do podanego identyfikatora elementu na Dysku i klucza zasobu, a następnie go zwraca.
enforceSingleParent(value)voidWłącza lub wyłącza wymuszanie zachowania SingleParent w przypadku wszystkich wywołań mających wpływ na elementy nadrzędne elementów.
getFileById(id)FilePobiera plik o podanym identyfikatorze.
getFileByIdAndResourceKey(id, resourceKey)FilePobiera plik o podanym identyfikatorze i kluczu zasobu.
getFiles()FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika.
getFilesByName(name)FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika o podanej nazwie.
getFilesByType(mimeType)FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika, które mają określony typ MIME.
getFolderById(id)FolderPobiera folder o podanym identyfikatorze.
getFolderByIdAndResourceKey(id, resourceKey)FolderPobiera folder o podanym identyfikatorze i kluczu zasobu.
getFolders()FolderIteratorPobiera zbiór wszystkich folderów na Dysku użytkownika.
getFoldersByName(name)FolderIteratorPobiera zbiór wszystkich folderów na Dysku użytkownika o podanej nazwie.
getRootFolder()FolderPobiera folder na poziomie głównym Dysku użytkownika.
getStorageLimit()IntegerPobiera liczbę bajtów, które użytkownik może zapisać na Dysku.
getStorageUsed()IntegerPobiera liczbę bajtów, które użytkownik obecnie przechowuje na Dysku.
getTrashedFiles()FileIteratorPobiera zbiór wszystkich plików znajdujących się w koszu na Dysku użytkownika.
getTrashedFolders()FolderIteratorPobiera zbiór wszystkich folderów z kosza na Dysku użytkownika.
searchFiles(params)FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika, które spełniają określone kryteria wyszukiwania.
searchFolders(params)FolderIteratorPobiera zbiór wszystkich folderów na Dysku użytkownika, które spełniają określone kryteria wyszukiwania.

Szczegółowa dokumentacja

continueFileIterator(continuationToken)

Wznawia iterację pliku przy użyciu tokena kontynuacji z poprzedniego iteratora. Ta metoda jest przydatna, gdy przetwarzanie iteratora w jednym wykonaniu przekracza maksymalny czas wykonania. Tokeny kontynuacji są zwykle ważne przez tydzień.

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

Parametry

NazwaTypOpis
continuationTokenStringToken kontynuacji z poprzedniego iteratora plików.

Powroty

FileIterator – zbiór plików, które pozostały we poprzednim iteratorze po wygenerowaniu tokena kontynuacji.


continueFolderIterator(continuationToken)

Wznawia iterację folderu przy użyciu tokena kontynuacji z poprzedniego iteratora. Ta metoda jest przydatna, gdy przetwarzanie iteratora w jednym wykonaniu przekracza maksymalny czas wykonania. Tokeny kontynuacji są zwykle ważne przez tydzień.

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

Parametry

NazwaTypOpis
continuationTokenStringToken kontynuacji z poprzedniego iteratora folderów.

Powroty

FolderIterator – zbiór folderów, które pozostały we poprzednim iteratorze podczas generowania tokena kontynuacji.


createFile(blob)

Tworzy plik w katalogu głównym Dysku użytkownika na podstawie Blob dowolnych danych.

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

Parametry

NazwaTypOpis
blobBlobSourceDane nowego pliku.

Powroty

File – nowy plik.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

createFile(name, content)

Tworzy w katalogu głównym Dysku użytkownika plik tekstowy o podanej nazwie i treści. Zwraca wyjątek, jeśli content ma rozmiar większy niż 50 MB.

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

Parametry

NazwaTypOpis
nameStringNazwa nowego pliku.
contentStringZawartość nowego pliku.

Powroty

File – nowy plik.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

createFile(name, content, mimeType)

W katalogu głównym Dysku użytkownika tworzy plik o podanej nazwie, treści i typie MIME. Jeśli rozmiar pliku content przekracza 10 MB, zgłasza wyjątek.

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

Parametry

NazwaTypOpis
nameStringNazwa nowego pliku.
contentStringZawartość nowego pliku.
mimeTypeStringTyp MIME nowego pliku.

Powroty

File – nowy plik.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

createFolder(name)

Tworzy folder o podanej nazwie w katalogu głównym Dysku użytkownika.

Parametry

NazwaTypOpis
nameStringNazwa nowego folderu.

Powroty

Folder – nowy folder.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

createShortcut(targetId)

Tworzy skrót do podanego identyfikatora elementu na Dysku, a następnie go zwraca.

Parametry

NazwaTypOpis
targetIdStringIdentyfikator pliku lub folderu docelowego.

Powroty

File – nowy skrót.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Tworzy skrót do podanego identyfikatora elementu na Dysku i klucza zasobu, a następnie go zwraca. Klucz zasobu to dodatkowy parametr, który trzeba przekazać, by uzyskać dostęp do pliku docelowego lub folderu udostępnionego przy użyciu linku.

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

Parametry

NazwaTypOpis
targetIdStringIdentyfikator pliku lub folderu docelowego.
targetResourceKeyStringKlucz zasobu docelowego pliku lub folderu.

Powroty

File – nowy skrót.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

enforceSingleParent(value)

Włącza lub wyłącza wymuszanie zachowania SingleParent w przypadku wszystkich wywołań mających wpływ na elementy nadrzędne elementów.

Więcej informacji znajdziesz na blogu na temat uproszczania struktury folderów i modeli udostępniania na Dysku Google.

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

Parametry

NazwaTypOpis
valueBooleanNowy stan flagi forceSingleParent.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFileById(id)

Pobiera plik o podanym identyfikatorze. Zgłasza wyjątek od obsługi skryptów w sytuacji, gdy plik nie istnieje lub użytkownik nie ma uprawnień dostępu do niego.

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

Parametry

NazwaTypOpis
idStringIdentyfikator pliku.

Powroty

File – plik o podanym identyfikatorze.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFileByIdAndResourceKey(id, resourceKey)

Pobiera plik o podanym identyfikatorze i kluczu zasobu. Klucze zasobów to dodatkowy parametr, który trzeba przekazać, aby uzyskać dostęp do plików udostępnionych za pomocą linku.

Zgłasza wyjątek od obsługi skryptów w sytuacji, gdy plik nie istnieje lub użytkownik nie ma uprawnień dostępu do niego.

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

Parametry

NazwaTypOpis
idStringIdentyfikator pliku.
resourceKeyStringKlucz zasobu folderu.

Powroty

File – plik o podanym identyfikatorze.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFiles()

Pobiera zbiór wszystkich plików na Dysku użytkownika.

Powroty

FileIterator – zbiór wszystkich plików na Dysku użytkownika.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFilesByName(name)

Pobiera zbiór wszystkich plików na Dysku użytkownika o podanej nazwie.

Parametry

NazwaTypOpis
nameStringNazwy plików do znalezienia.

Powroty

FileIterator – zbiór wszystkich plików na Dysku użytkownika, które mają określoną nazwę.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFilesByType(mimeType)

Pobiera zbiór wszystkich plików na Dysku użytkownika, które mają określony typ MIME.

Parametry

NazwaTypOpis
mimeTypeStringTyp MIME plików do znalezienia.

Powroty

FileIterator – zbiór wszystkich plików na Dysku użytkownika, które mają określony typ MIME.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFolderById(id)

Pobiera folder o podanym identyfikatorze. Zgłasza wyjątek skryptu w przypadku, gdy folder nie istnieje lub użytkownik nie ma uprawnień dostępu do niego.

Parametry

NazwaTypOpis
idStringIdentyfikator folderu.

Powroty

Folder – folder o podanym identyfikatorze.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFolderByIdAndResourceKey(id, resourceKey)

Pobiera folder o podanym identyfikatorze i kluczu zasobu. Klucze zasobów to dodatkowy parametr, który trzeba przekazać, aby uzyskać dostęp do folderów udostępnionych za pomocą linku.

Jeśli folder nie istnieje lub użytkownik nie ma uprawnień dostępu do niego, zgłasza wyjątek dotyczący obsługi skryptów.

Parametry

NazwaTypOpis
idStringIdentyfikator folderu.
resourceKeyStringKlucz zasobu folderu.

Powroty

Folder – folder o podanym identyfikatorze.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFolders()

Pobiera zbiór wszystkich folderów na Dysku użytkownika.

Powroty

FolderIterator – zbiór wszystkich folderów na Dysku użytkownika.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getFoldersByName(name)

Pobiera zbiór wszystkich folderów na Dysku użytkownika o podanej nazwie.

Parametry

NazwaTypOpis
nameStringNazwa folderów do znalezienia.

Powroty

FolderIterator – zbiór wszystkich folderów na Dysku użytkownika, które mają określoną nazwę.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getRootFolder()

Pobiera folder na poziomie głównym Dysku użytkownika.

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

Powroty

Folder – folder główny Dysku użytkownika.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getStorageLimit()

Pobiera liczbę bajtów, które użytkownik może zapisać na Dysku.

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

Powroty

Integer – liczba bajtów, które użytkownik może zapisać na Dysku.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getStorageUsed()

Pobiera liczbę bajtów, które użytkownik obecnie przechowuje na Dysku.

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

Powroty

Integer – liczba bajtów, które użytkownik obecnie przechowuje na Dysku.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getTrashedFiles()

Pobiera zbiór wszystkich plików znajdujących się w koszu na Dysku użytkownika.

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

Powroty

FileIterator – zbiór plików w koszu.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getTrashedFolders()

Pobiera zbiór wszystkich folderów z kosza na Dysku użytkownika.

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

Powroty

FolderIterator – zbiór folderów w koszu.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

searchFiles(params)

Pobiera zbiór wszystkich plików na Dysku użytkownika, które spełniają określone kryteria wyszukiwania. Szczegółowe informacje na temat kryteriów wyszukiwania znajdziesz w dokumentacji pakietu SDK Dysku Google. Pamiętaj, że usługa Dysk korzysta z interfejsu Drive API w wersji 2, a niektóre pola zapytań różnią się od wersji 3. Zapoznaj się z różnicami między wersją 2 a 3.

Argument params to ciąg zapytania, który może zawierać wartości w postaci ciągów znaków. Pamiętaj więc, aby prawidłowo zmieniać znaczenie cudzysłowów (np. "title contains 'Gulliver\\'s Travels'" lub '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());
}

Parametry

NazwaTypOpis
paramsStringKryteria wyszukiwania zgodnie z dokumentacją pakietu SDK Dysku Google.

Powroty

FileIterator – zbiór wszystkich plików na Dysku użytkownika, które spełniają kryteria wyszukiwania.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

searchFolders(params)

Pobiera zbiór wszystkich folderów na Dysku użytkownika, które spełniają określone kryteria wyszukiwania. Szczegółowe informacje na temat kryteriów wyszukiwania znajdziesz w dokumentacji pakietu SDK Dysku Google. Pamiętaj, że usługa Dysk korzysta z interfejsu Drive API w wersji 2, a niektóre pola zapytań różnią się od wersji 3. Zapoznaj się z różnicami między wersją 2 a 3.

Argument params to ciąg zapytania, który może zawierać wartości w postaci ciągów znaków. Pamiętaj więc, aby prawidłowo zmieniać znaczenie cudzysłowów (np. "title contains 'Gulliver\\'s Travels'" lub '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());
}

Parametry

NazwaTypOpis
paramsStringKryteria wyszukiwania zgodnie z dokumentacją pakietu SDK Dysku Google.

Powroty

FolderIterator – zbiór wszystkich folderów na Dysku użytkownika, które spełniają kryteria wyszukiwania.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

Wycofane metody