Class DriveApp

DriveApp

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

// 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
AccessAccessEnum reprezentujące klasy użytkowników, którzy mają dostęp do pliku lub folderu, oprócz poszczególnych osób użytkownikom, którym wprost przyznano dostęp.
PermissionPermissionEnum reprezentujące uprawnienia przyznane użytkownikom, którzy mają dostęp do pliku lub folderu: wszystkim użytkownikom, którym wprost 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 iteracji.
createFile(blob)FileTworzy plik w katalogu głównym Dysku użytkownika na podstawie wybranych danych (Blob)
createFile(name, content)FileTworzy plik tekstowy o podanej nazwie i zawartości w katalogu głównym Dysku użytkownika.
createFile(name, content, mimeType)FileTworzy plik o podanej nazwie, zawartości i typie MIME w katalogu głównym Dysku użytkownika.
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 i zwraca ten identyfikator.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTworzy skrót do podanego identyfikatora elementu na Dysku i klucza zasobu i zwraca ten skrót.
enforceSingleParent(value)voidWłącza lub wyłącza zachowanie forceSingleParent w przypadku wszystkich wywołań mających wpływ 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 o podanej nazwie.
getFilesByType(mimeType)FileIteratorPobiera kolekcję wszystkich plików z Dysku użytkownika o podanym typie 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 o podanej nazwie.
getRootFolder()FolderPobiera folder znajdujący się 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 Dysku użytkownika.
getTrashedFolders()FolderIteratorPobiera kolekcję wszystkich folderów w koszu Dysku użytkownika.
searchFiles(params)FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika, które pasują do zapytania kryteria.
searchFolders(params)FolderIteratorPobiera zbiór wszystkich folderów na Dysku użytkownika, które pasują do zapytania kryteria.

Szczegółowa dokumentacja

continueFileIterator(continuationToken)

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

Powrót

FileIterator – zbiór plików, które pozostały w poprzednim iteratorze, gdy token kontynuacji .

continueFolderIterator(continuationToken)

Wznawia iterację folderu przy użyciu tokena kontynuacji z poprzedniego iteracji. Ta metoda jest przydatne, jeśli przetwarzanie iteratora jednego wykonania 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 podczas kontynuacji. .

createFile(blob)

Tworzy plik w katalogu głównym Dysku użytkownika na podstawie wybranych danych (Blob) 

// 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.

Powrót

File – nowy plik.

Autoryzacja

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 plik tekstowy o podanej nazwie i zawartości w katalogu głównym Dysku użytkownika. Wyrzuca wyjątek, jeśli rozmiar content przekracza 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.

Powrót

File – nowy plik.

Autoryzacja

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)

Tworzy plik o podanej nazwie, zawartości i typie MIME w katalogu głównym Dysku użytkownika. Rzuty wyjątek, jeśli rozmiar 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.
contentStringZawartość nowego pliku.
mimeTypeStringTyp MIME nowego pliku.

Powrót

File – nowy plik.

Autoryzacja

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.

Powrót

Folder – nowy folder.

Autoryzacja

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 i zwraca ten identyfikator.

Parametry

NazwaTypOpis
targetIdStringIdentyfikator pliku docelowego lub folderu docelowego.

Powrót

File – nowy skrót.

Autoryzacja

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 i zwraca ten skrót. Zasób klucz to dodatkowy parametr, który musi zostać przekazany, aby uzyskać dostęp do docelowego pliku lub folderu, który Element został udostępniony 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 pliku lub folderu docelowego.
targetResourceKeyStringKlucz zasobu docelowego pliku lub folderu.

Powrót

File – nowy skrót.

Autoryzacja

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 zachowanie forceSingleParent w przypadku wszystkich wywołań mających wpływ na elementy nadrzędne.

Więcej informacji znajdziesz na blogu uping Google Drive of Google folder and Share models (Upraszczanie 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 wymuszonej jednostki nadrzędnej.

Autoryzacja

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 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 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óre są wymagane, aby uzyskać dostęp do plików, które zostały udostępnione za pomocą linku.

Zgłasza wyjątek skryptu, jeśli plik nie istnieje lub użytkownik nie ma uprawnień aby uzyskać do niego dostęp. 

// 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 co najmniej jednym 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 – kolekcja wszystkich plików na Dysku użytkownika.

Autoryzacja

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 kolekcję wszystkich plików na Dysku użytkownika o podanej nazwie.

Parametry

NazwaTypOpis
nameStringNazwa plików do znalezienia.

Powrót

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

Autoryzacja

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 kolekcję wszystkich plików z Dysku użytkownika o podanym typie 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 kod MIME. typu.

Autoryzacja

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, 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 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óre są wymagane, aby uzyskać dostęp do folderów, które zostały udostępnione za pomocą linku.

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

Parametry

NazwaTypOpis
idStringIdentyfikator folderu.
resourceKeyStringKlucz zasobu folderu.

Powrót

Folder – folder o podanym identyfikatorze.

Autoryzacja

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 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 co najmniej jednym 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 o podanej nazwie.

Parametry

NazwaTypOpis
nameStringNazwa 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 co najmniej jednym z tych zakresów:

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

getRootFolder()

Pobiera folder znajdujący się 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 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 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 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());

Powrót

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

Autoryzacja

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 kolekcję wszystkich plików w koszu 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 – kolekcja plików w koszu.

Autoryzacja

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 kolekcję wszystkich folderów w koszu 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 – kolekcja folderów w koszu.

Autoryzacja

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 pasują do zapytania kryteria. Szczegółowe informacje o kryteriach wyszukiwania znajdziesz w dokumentacji pakietu SDK Dysku Google. Pamiętaj, że Dysk usługa korzysta z interfejsu Drive API w wersji 2, a niektóre pola zapytania różnią się od wersji 3. Przeanalizuj pole różnice między wersjami 2 i 3.

Argument params to ciąg zapytania, który może zawierać wartości w postaci ciągów znaków, dlatego zachowaj ostrożność. aby prawidłowo zmienić znaczenie cudzysłowów (na przykład "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 opisane w dokumentacji pakietu SDK Dysku Google;

Powrót

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

Autoryzacja

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 pasują do zapytania kryteria. Szczegółowe informacje o kryteriach wyszukiwania znajdziesz w dokumentacji pakietu SDK Dysku Google. Pamiętaj, że Dysk usługa korzysta z interfejsu Drive API w wersji 2, a niektóre pola zapytania różnią się od wersji 3. Przeanalizuj pole różnice między wersjami 2 i 3.

Argument params to ciąg zapytania, który może zawierać wartości w postaci ciągów znaków, dlatego zachowaj ostrożność. aby prawidłowo zmienić znaczenie cudzysłowów (na przykład "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 opisane w dokumentacji pakietu SDK Dysku Google;

Powrót

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

Autoryzacja

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