Class DriveApp

Aplikacja Dysku

Umożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików i folderów na Dysku Google. Aby uzyskać dostęp do plików lub 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

UsługaTypOpis
AccessAccessWyliczenie wskazuje klasy użytkowników, którzy mają dostęp do pliku lub folderu, oraz pojedynczych użytkowników, którym przyznano dostęp wprost.
PermissionPermissionWyliczenie symbolizujące uprawnienia użytkownikom, którzy mają dostęp do pliku lub folderu, oraz innym użytkownikom, którym jednoznacznie przyznano dostęp.

Metody

MetodaZwracany typKrótki opis
continueFileIterator(continuationToken)FileIteratorWznowienie iteracji pliku przy użyciu tokena kontynuacji z poprzedniego iteratora.
continueFolderIterator(continuationToken)FolderIteratorWznowienie iteracji folderu przy użyciu tokena kontynuacji z poprzedniego iteratora.
createFile(blob)FileTworzy plik w katalogu głównym Dysku użytkownika na podstawie określonych Blob dowolnych danych.
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, treści i typie MIME.
createFolder(name)FolderPowoduje utworzenie folderu głównego na 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 elementu elementu na Dysku i klucza zasobu, a następnie go zwraca.
enforceSingleParent(value)voidWłącza lub wyłącza egzekwowanie funkcji SingleSingle dla wszystkich wywołań dotyczących elementów nadrzędnych elementu.
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, które mają określoną nazwę.
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 kolekcję wszystkich folderów na Dysku użytkownika.
getFoldersByName(name)FolderIteratorPobiera kolekcję wszystkich folderów na Dysku użytkownika o określonej nazwie.
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 przechowywanych przez użytkownika na Dysku.
getTrashedFiles()FileIteratorPobiera zbiór wszystkich plików znajdujących się w koszu na Dysku użytkownika.
getTrashedFolders()FolderIteratorPobiera kolekcję wszystkich folderów w koszu 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)

Wznowienie iteracji 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 pliku.

Powrót

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


continueFolderIterator(continuationToken)

Wznowienie iteracji folderu 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 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 iteracji podczas generowania tokena kontynuacji;


createFile(blob)

Tworzy plik w katalogu głównym Dysku użytkownika na podstawie określonych 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.

Powrót

File – nowy plik.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 rozmiar 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.
contentStringZawartość nowego pliku.

Powrót

File – nowy plik.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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, treści i typie MIME. Wyjątek, jeśli content ma więcej niż 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.

Upoważnienie

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

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

createFolder(name)

Powoduje utworzenie folderu głównego na Dysku użytkownika o podanej nazwie.

Parametry

NazwaTypOpis
nameStringNazwa nowego folderu.

Powrót

Folder – nowy folder.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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.

Upoważnienie

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

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Tworzy skrót do podanego elementu 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 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 docelowego lub folderu.
targetResourceKeyStringKlucz zasobu docelowego pliku lub folderu.

Powrót

File – nowy skrót.

Upoważnienie

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

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

enforceSingleParent(value)

Włącza lub wyłącza egzekwowanie funkcji SingleSingle dla wszystkich wywołań dotyczących elementów nadrzędnych elementu.

Więcej informacji znajdziesz na blogu o uproszczeniu struktury folderów na Dysku Google i udostępnianiu modeli.

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

Parametry

NazwaTypOpis
valueBooleanNowy stan flagi egzekwowania singla nadrzędnego.

Upoważnienie

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

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

getFileById(id)

Pobiera plik o podanym identyfikatorze. Zwraca wyjątek skryptu, jeśli plik nie istnieje lub użytkownik nie ma do niego dostępu.

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 trzeba przekazać, aby uzyskać dostęp do plików, które zostały udostępnione za pomocą linku.

Zwraca wyjątek skryptu, jeśli plik nie istnieje lub użytkownik nie ma do niego dostępu.

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego 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.

Powrót

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego 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, które mają określoną nazwę.

Parametry

NazwaTypOpis
nameStringNazwa plików, które chcesz znaleźć.

Powrót

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 za pomocą co najmniej jednego 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, które chcesz znaleźć.

Powrót

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 za pomocą 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. Zwraca wyjątek skryptu, jeśli folder nie istnieje lub użytkownik nie ma do niego dostępu.

Parametry

NazwaTypOpis
idStringIdentyfikator folderu.

Powrót

Folder – folder o podanym identyfikatorze.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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ć do folderów dostępu udostępnionych przy użyciu linku.

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 – zbiór wszystkich folderów na Dysku użytkownika,

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 o określonej nazwie.

Parametry

NazwaTypOpis
nameStringNazwa folderów, które chcesz znaleźć.

Powrót

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 za pomocą 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.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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 przechowywanych przez użytkownika 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 przechowuje obecnie na Dysku.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego 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());
}

Powrót

FileIterator – zbiór plików w koszu;

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą 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.

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego 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. Kryteria wyszukiwania znajdziesz w dokumentacji pakietu SDK Dysku Google. Zwróć uwagę, że usługa Dysk używa wersji 2 interfejsu Drive API i niektórych pól zapytania różni się od wersji 3. Przejrzyj różnice między polami w wersjach 2 i 3.

Argument params to ciąg zapytania, który może zawierać wartości ciągu, więc uważaj, aby odpowiednio zmienić 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 opisem w dokumentacji pakietu SDK Dysku Google;

Powrót

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

Upoważnienie

Skrypty korzystające z tej metody wymagają autoryzacji za pomocą co najmniej jednego 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. Kryteria wyszukiwania znajdziesz w dokumentacji pakietu SDK Dysku Google. Zwróć uwagę, że usługa Dysk używa wersji 2 interfejsu Drive API i niektórych pól zapytania różni się od wersji 3. Przejrzyj różnice między polami w wersjach 2 i 3.

Argument params to ciąg zapytania, który może zawierać wartości ciągu, więc uważaj, aby odpowiednio zmienić 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 opisem w dokumentacji pakietu SDK Dysku Google;

Powrót

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

Upoważnienie

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

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

Metody wycofane