Class DriveApp

DriveApp

Umożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików oraz folderów na Dysku Google. Wbudowana usługa Dysk jest łatwiejsza w użyciu, ale ma pewne ograniczenia. Aby korzystać z najnowszych funkcji i pomocy oraz uzyskiwać dostęp do plików i folderów na dyskach współdzielonych, używaj zaawansowanej usługi Dysku. 

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

Właściwości

WłaściwośćTypOpis
AccessAccessWyliczenie reprezentujące klasy użytkowników, którzy mogą uzyskać dostęp do pliku lub folderu, oprócz użytkowników, którym wyraźnie przyznano dostęp.
PermissionPermissionWyliczenie reprezentujące uprawnienia przyznane użytkownikom, którzy mają dostęp do pliku lub folderu, oprócz użytkowników, którym wyraźnie 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, używając tokena kontynuacji z poprzedniego iteratora.
createFile(blob)FileTworzy plik w folderze głównym na Dysku użytkownika na podstawie podanego obiektu Blob z dowolnymi danymi.
createFile(name, content)FileTworzy plik tekstowy w katalogu głównym Dysku użytkownika o podanej nazwie i zawartości.
createFile(name, content, mimeType)FileTworzy plik w katalogu głównym Dysku użytkownika o podanej nazwie, zawartości i typie MIME.
createFolder(name)FolderTworzy folder w katalogu głównym Dysku użytkownika o podanej nazwie.
createShortcut(targetId)FileTworzy skrót do podanego identyfikatora elementu na Dysku i zwraca go.
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 zachowanie enforceSingleParent w przypadku wszystkich wywołań wpływających na elementy nadrzędne.
getFileById(id)FilePobiera plik o podanym identyfikatorze.
getFileByIdAndResourceKey(id, resourceKey)FilePobiera plik o podanym identyfikatorze i kluczu zasobu.
getFiles()FileIteratorPobiera kolekcję wszystkich plików na Dysku użytkownika.
getFilesByName(name)FileIteratorPobiera kolekcję wszystkich plików na Dysku użytkownika, które mają podaną nazwę.
getFilesByType(mimeType)FileIteratorPobiera kolekcję wszystkich plików na Dysku użytkownika, które mają podany typ MIME.
getFolderById(id)FolderPobiera folder o podanym identyfikatorze.
getFolderByIdAndResourceKey(id, resourceKey)FolderPobiera folder o podanym identyfikatorze i kluczu zasobu.
getFolders()FolderIteratorPobiera kolekcję wszystkich folderów na Dysku użytkownika.
getFoldersByName(name)FolderIteratorPobiera kolekcję wszystkich folderów na Dysku użytkownika, które mają podaną nazwę.
getRootFolder()FolderPobiera folder w katalogu głównym Dysku użytkownika.
getStorageLimit()IntegerPobiera liczbę bajtów, które użytkownik może przechowywać na Dysku.
getStorageUsed()IntegerPobiera liczbę bajtów, które użytkownik obecnie przechowuje na Dysku.
getTrashedFiles()FileIteratorPobiera kolekcję wszystkich plików w koszu na Dysku użytkownika.
getTrashedFolders()FolderIteratorPobiera kolekcję wszystkich folderów w koszu na Dysku użytkownika.
searchFiles(params)FileIteratorPobiera kolekcję wszystkich plików na Dysku użytkownika, które pasują do podanych kryteriów wyszukiwania.
searchFolders(params)FolderIteratorPobiera kolekcję wszystkich folderów na Dysku użytkownika, które spełniają podane kryteria wyszukiwania.

Szczegółowa dokumentacja

continueFileIterator(continuationToken)

Wznawia iterację pliku przy użyciu tokena kontynuacji z poprzedniego iteratora. Ta metoda jest przydatna, jeśli 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.

Powrót

FileIterator – zbiór plików, które pozostały w poprzednim iteratorze w momencie wygenerowania tokena kontynuacji.

continueFolderIterator(continuationToken)

Wznawia iterację folderu, używając tokena kontynuacji z poprzedniego iteratora. Ta metoda jest przydatna, jeśli 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 folderu.

Powrót

FolderIterator – zbiór folderów, które pozostały w poprzednim iteratorze, gdy został wygenerowany token kontynuacji.

createFile(blob)

Tworzy plik w folderze głównym na Dysku użytkownika na podstawie podanego obiektu Blob z dowolnymi danymi.

Parametry

NazwaTypOpis
blobBlobSourceDane nowego pliku.

Powrót

File – nowy plik.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

createFile(name, content)

Tworzy plik tekstowy w katalogu głównym Dysku użytkownika o podanej nazwie i zawartości. Zwraca wyjątek, jeśli content jest 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.
contentStringTreść nowego pliku.

Powrót

File – nowy plik.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

createFile(name, content, mimeType)

Tworzy plik w katalogu głównym Dysku użytkownika o podanej nazwie, zawartości i typie MIME. Zwraca wyjątek, jeśli rozmiar pliku content przekracza 10 MB. 

// 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.
contentStringTreść nowego pliku.
mimeTypeStringTyp MIME nowego pliku.

Powrót

File – nowy plik.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

createFolder(name)

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

Parametry

NazwaTypOpis
nameStringNazwa nowego folderu.

Powrót

Folder – nowy folder.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

createShortcut(targetId)

Tworzy skrót do podanego identyfikatora elementu na Dysku i zwraca go.

Parametry

NazwaTypOpis
targetIdStringIdentyfikator pliku docelowego lub folderu.

Powrót

File – nowy skrót.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 należy przekazać, aby uzyskać dostęp do docelowego pliku lub folderu udostępnionego za pomocą 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 docelowego pliku lub folderu.
targetResourceKeyStringKlucz zasobu docelowego pliku lub folderu.

Powrót

File – nowy skrót.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

enforceSingleParent(value)

Włącza lub wyłącza zachowanie enforceSingleParent w przypadku wszystkich wywołań wpływających na elementy nadrzędne.

Więcej informacji znajdziesz na blogu Uproszczenie 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 enforceSingleParent.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getFileById(id)

Pobiera plik o podanym identyfikatorze. Zgłasza wyjątek skryptu, jeśli 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.

Powrót

File – plik o podanym identyfikatorze.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 należy przekazać, aby uzyskać dostęp do plików udostępnionych za pomocą linku.

Zgłasza wyjątek skryptu, jeśli 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.

Powrót

File – plik o podanym identyfikatorze.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getFiles()

Pobiera kolekcję wszystkich plików na Dysku użytkownika.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getFilesByName(name)

Pobiera kolekcję wszystkich plików na Dysku użytkownika, które mają podaną nazwę.

Parametry

NazwaTypOpis
nameStringNazwy plików do znalezienia.

Powrót

FileIterator – kolekcja wszystkich plików na Dysku użytkownika, które mają podaną nazwę.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getFilesByType(mimeType)

Pobiera kolekcję wszystkich plików na Dysku użytkownika, które mają podany typ MIME.

Parametry

NazwaTypOpis
mimeTypeStringTyp MIME plików do znalezienia.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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, jeśli folder nie istnieje lub użytkownik nie ma uprawnień dostępu do niego.

Parametry

NazwaTypOpis
idStringIdentyfikator folderu.

Powrót

Folder – folder o podanym identyfikatorze.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 należy przekazać, aby uzyskać dostęp do folderów udostępnionych za pomocą linku.

Zgłasza wyjątek skryptu, jeśli folder nie istnieje lub użytkownik nie ma uprawnień dostępu do niego.

Parametry

NazwaTypOpis
idStringIdentyfikator folderu.
resourceKeyStringKlucz zasobu folderu.

Powrót

Folder – folder o podanym identyfikatorze.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getFolders()

Pobiera kolekcję wszystkich folderów na Dysku użytkownika.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getFoldersByName(name)

Pobiera kolekcję wszystkich folderów na Dysku użytkownika, które mają podaną nazwę.

Parametry

NazwaTypOpis
nameStringNazwy folderów do znalezienia.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getRootFolder()

Pobiera folder w katalogu 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());

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 przechowywać na Dysku. 

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

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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());

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getTrashedFiles()

Pobiera kolekcję wszystkich plików 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());
}

Powrót

FileIterator – zbiór plików w koszu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

getTrashedFolders()

Pobiera kolekcję wszystkich folderów w koszu 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());
}

Powrót

FolderIterator – zbiór folderów w koszu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

searchFiles(params)

Pobiera kolekcję wszystkich plików na Dysku użytkownika, które pasują do podanych kryteriów wyszukiwania. Kryteria wyszukiwania są szczegółowo opisane 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 tych w wersji 3. Sprawdź różnice w polach między wersjami 2 i 3.

Argument params to ciąg zapytania, który może zawierać wartości tekstowe, więc uważaj, aby poprawnie używać znaków cudzysłowu (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.""
const files = DriveApp.searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getName());
}

Parametry

NazwaTypOpis
paramsStringKryteria wyszukiwania zgodnie z opisem w dokumentacji pakietu SDK Dysku Google.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

searchFolders(params)

Pobiera kolekcję wszystkich folderów na Dysku użytkownika, które spełniają podane kryteria wyszukiwania. Kryteria wyszukiwania są szczegółowo opisane 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 tych w wersji 3. Sprawdź różnice w polach między wersjami 2 i 3.

Argument params to ciąg zapytania, który może zawierać wartości tekstowe, więc uważaj, aby poprawnie używać znaków cudzysłowu (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.
const folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

Parametry

NazwaTypOpis
paramsStringKryteria wyszukiwania zgodnie z opisem w dokumentacji pakietu SDK Dysku Google.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Wycofane metody