Class DriveApp

Aplikacja Dysku

Umożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików oraz folderów na Dysku Google.

// Log the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

Właściwości

WłaściwośćTypOpis
AccessAccessWartość wyliczeniowa przedstawiająca grupy użytkowników, którzy mają dostęp do pliku lub folderu, oraz poszczególnych użytkowników, którym przyznano dostęp.
PermissionPermissionLista wyliczeniowa przedstawiająca uprawnienia użytkownikom, którzy mają dostęp do pliku lub folderu, oraz poszczególnym użytkownikom, którym jednoznacznie przyznano dostęp.

Metody

MetodaZwracany typKrótki opis
continueFileIterator(continuationToken)FileIteratorWznawia iterację pliku za pomocą tokena kontynuacji z poprzedniego iteratora.
continueFolderIterator(continuationToken)FolderIteratorWznawia iterację folderu z użyciem tokena kontynuacji z poprzedniego iteratora.
createFile(blob)FileTworzy plik w katalogu głównym użytkownika na określonym dysku Blob z arbitralnych danych.
createFile(name, content)FileTworzy plik tekstowy w katalogu głównym konta użytkownika z podaną nazwą i treś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 konta użytkownika o podanej nazwie.
createShortcut(targetId)FileTworzy skrót do podanego identyfikatora elementu Dysku i zwraca go.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTworzy skrót do podanego identyfikatora elementu Dysku i klucza zasobu, a następnie go zwraca.
enforceSingleParent(value)voidWłącza lub wyłącza wymuszanie działania funkcji PojedynczyMata 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 o danej nazwie.
getFilesByType(mimeType)FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika o określonym typie 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 danej nazwie.
getRootFolder()FolderPobiera folder do katalogu głównego 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 z kosza użytkownika na Dysk.
getTrashedFolders()FolderIteratorPobiera zbiór wszystkich folderów do 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ą podane kryteria wyszukiwania.

Szczegółowa dokumentacja

continueFileIterator(continuationToken)

Wznawia iterację pliku za pomocą tokena kontynuacji z poprzedniego iteratora. Ta metoda jest przydatna, gdy przetwarzanie pojedynczego iteratora powoduje przekroczenie maksymalnego czasu wykonania. Tokeny kontynuacji są zwykle ważne przez tydzień.

Parametry

NazwaTypOpis
continuationTokenStringtoken kontynuacji z poprzedniego iteratora

Zwróć

FileIterator – zbiór plików, które pozostały w poprzednim iteracji podczas generowania tokena kontynuacji.


continueFolderIterator(continuationToken)

Wznawia iterację folderu z użyciem tokena kontynuacji z poprzedniego iteratora. Ta metoda jest przydatna, gdy przetwarzanie pojedynczego iteratora powoduje przekroczenie maksymalnego czasu wykonania. Tokeny kontynuacji są zwykle ważne przez tydzień.

Parametry

NazwaTypOpis
continuationTokenStringtoken kontynuacji z poprzedniego iteratora folderu

Zwróć

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


createFile(blob)

Tworzy plik w katalogu głównym użytkownika na określonym dysku Blob z arbitralnych 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 do nowego pliku.

Zwróć

File – nowy plik.

Autoryzacja

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

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

createFile(name, content)

Tworzy plik tekstowy w katalogu głównym konta użytkownika z podaną nazwą i treś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.

Zwróć

File – nowy plik.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 właściwość content jest większa 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.

Zwróć

File – nowy plik.

Autoryzacja

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

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

createFolder(name)

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

Parametry

NazwaTypOpis
nameStringNazwa nowego folderu.

Zwróć

Folder – nowy folder.

Autoryzacja

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

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

createShortcut(targetId)

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

Parametry

NazwaTypOpis
targetIdStringIdentyfikator pliku docelowego lub folderu.

Zwróć

File – nowy skrót.

Autoryzacja

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

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

Tworzy skrót do podanego identyfikatora elementu Dysku i klucza zasobu, a następnie go zwraca. Klucze zasobów to dodatkowy parametr, który trzeba przekazać, aby uzyskać dostęp do pliku docelowego lub folderu udostępnionego za pomocą linku.

Parametry

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

Zwróć

File – nowy skrót.

Autoryzacja

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

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

enforceSingleParent(value)

Włącza lub wyłącza wymuszanie działania funkcji PojedynczyMata dla wszystkich wywołań dotyczących elementów nadrzędnych elementu.

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

Parametry

NazwaTypOpis
valueBooleanNowy stan flagiforcesingleParent.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Parametry

NazwaTypOpis
idStringidentyfikator pliku;

Zwróć

File – plik o podanym identyfikatorze.

Autoryzacja

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

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

Parametry

NazwaTypOpis
idStringIdentyfikator pliku.
resourceKeyStringKlucz zasobu folderu.

Zwróć

File – plik o podanym identyfikatorze.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 o danej nazwie.

Parametry

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

Zwróć

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 o określonym typie MIME.

Parametry

NazwaTypOpis
mimeTypeStringTyp MIME plików, które mają zostać znalezione.

Zwróć

FileIterator – zbiór wszystkich plików na Dysku użytkownika z określonym typem MIME.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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

Zwróć

Folder – folder o podanym identyfikatorze.

Autoryzacja

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

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

Parametry

NazwaTypOpis
idStringIdentyfikator folderu.
resourceKeyStringKlucz zasobu folderu.

Zwróć

Folder – folder o podanym identyfikatorze.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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.

Zwróć

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 danej nazwie.

Parametry

NazwaTypOpis
nameStringNazwa folderów do znalezienia.

Zwróć

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

Autoryzacja

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

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

getRootFolder()

Pobiera folder do katalogu głównego Dysku użytkownika.

Zwróć

Folder – folder główny Dysku użytkownika

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Zwróć

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 z kosza użytkownika na Dysk.

Zwróć

FileIterator – zbiór plików z kosza,

Autoryzacja

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

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

getTrashedFolders()

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

Zwróć

FolderIterator – zbiór folderów z kosza,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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. Argument params jest ciągiem zapytania, który może zawierać wartości ciągu, więc pamiętaj o odpowiednim korzystaniu ze znaków zmiany znaczenia w cudzysłowie (np. "title contains 'Gulliver\\'s Travels'" lub 'title contains "Gulliver\'s Travels"').

// Log the name of every file in the user's Drive that modified after February 28,
// 2013 whose name contains "untitled".
var files = DriveApp.searchFiles(
    'modifiedDate > "2013-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

Parametry

NazwaTypOpis
paramsStringkryteria wyszukiwania opisane w dokumentacji pakietu SDK Dysku Google;

Zwróć

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 przy użyciu 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ą podane kryteria wyszukiwania. Kryteria wyszukiwania znajdziesz w dokumentacji pakietu SDK Dysku Google. Argument params jest ciągiem zapytania, który może zawierać wartości ciągu, więc pamiętaj o odpowiednim korzystaniu ze znaków zmiany znaczenia w cudzysłowie (np. "title contains 'Gulliver\\'s Travels'" lub 'title contains "Gulliver\'s Travels"').

// Log 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();
  Logger.log(folder.getName());
}

Parametry

NazwaTypOpis
paramsStringkryteria wyszukiwania opisane w dokumentacji pakietu SDK Dysku Google;

Zwróć

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 przy użyciu co najmniej jednego z tych zakresów:

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

Wycofane metody