Umożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików oraz folderów na Dysku Google. Aby uzyskać dostęp do plików lub folderów na dyskach współdzielonych, użyj zaawansowanego 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ść | Typ | Opis |
---|---|---|
Access | Access | Enum reprezentujący klasy użytkowników, którzy mogą uzyskać dostęp do pliku lub folderu, oprócz poszczególnych użytkowników, którzy uzyskali dostęp. |
Permission | Permission | Enum reprezentujący uprawnienia przyznane użytkownikom, którzy mogą uzyskać dostęp do pliku lub folderu, oprócz poszczególnych użytkowników, którym przyznano dostęp. |
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
continue | File | Wznowienie iteracji pliku za pomocą tokena kontynuacji z poprzedniego iteratora. |
continue | Folder | Wznawia iterację folderu za pomocą tokena kontynuacji z poprzedniego iteratora. |
create | File | Tworzy plik w katalogu głównym Dysku użytkownika na podstawie dowolnych danych z danego Blob . |
create | File | Tworzy plik tekstowy w folderze głównym Dysku użytkownika o określonej nazwie i zawartości. |
create | File | Tworzy plik w katalogu głównym Dysku użytkownika z podaną nazwą, treścią i typem MIME. |
create | Folder | Tworzy folder o podanej nazwie w katalogu głównym Dysku użytkownika. |
create | File | Tworzy skrót do podanego identyfikatora elementu na Dysku i zwraca go. |
create | File | Tworzy i zwraca skrót do podanego identyfikatora elementu i klucza zasobu na Dysku. |
enforce | void | Włącza lub wyłącza zachowanie enforceSingleParent dla wszystkich wywołań wpływających na elementy nadrzędne. |
get | File | Pobiera plik o podanym identyfikatorze. |
get | File | Pobiera plik o podanym identyfikatorze i kluczu zasobu. |
get | File | Pobiera kolekcję wszystkich plików na Dysku użytkownika. |
get | File | Pobiera kolekcję wszystkich plików na Dysku użytkownika, które mają daną nazwę. |
get | File | Pobiera kolekcję wszystkich plików na Dysku użytkownika, które mają dany typ MIME. |
get | Folder | Pobiera folder o podanym identyfikatorze. |
get | Folder | Pobiera folder o podanym identyfikatorze i kluczu zasobu. |
get | Folder | Pobiera kolekcję wszystkich folderów na Dysku użytkownika. |
get | Folder | Pobiera kolekcję wszystkich folderów na Dysku użytkownika, które mają podaną nazwę. |
get | Folder | Pobiera folder znajdujący się w katalogu głównym Dysku użytkownika. |
get | Integer | Pobiera liczbę bajtów, które użytkownik może przechowywać na Dysku. |
get | Integer | Pobiera liczbę bajtów, które użytkownik aktualnie przechowuje na Dysku. |
get | File | Pobiera kolekcję wszystkich plików znajdujących się w koszu na Dysku użytkownika. |
get | Folder | Pobiera kolekcję wszystkich folderów znajdujących się w koszu na Dysku użytkownika. |
search | File | Pobiera kolekcję wszystkich plików na Dysku użytkownika, które pasują do podanych kryteriów wyszukiwania. |
search | Folder | Pobiera kolekcję wszystkich folderów na Dysku użytkownika, które pasują do podanych kryteriów wyszukiwania. |
Szczegółowa dokumentacja
continue File Iterator(continuationToken)
Wznowienie iteracji pliku za pomocą 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
Nazwa | Typ | Opis |
---|---|---|
continuation | String | Token kontynuacji z poprzedniego iteratora plików. |
Powrót
File
– zbiór plików, które pozostały w poprzednim iteracji po wygenerowaniu tokena kontynuacji.
continue Folder Iterator(continuationToken)
Wznawia iterację folderu za pomocą 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
Nazwa | Typ | Opis |
---|---|---|
continuation | String | Token kontynuacji z poprzedniego iteratora folderu. |
Powrót
Folder
– kolekcja folderów, które pozostały w poprzednim iteracji po wygenerowaniu tokena kontynuacji.
create File(blob)
Tworzy plik w katalogu głównym Dysku użytkownika na podstawie dowolnych danych z danego Blob
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
blob | Blob | dane nowego pliku. |
Powrót
File
– nowy plik.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
create File(name, content)
Tworzy plik tekstowy w folderze głównym Dysku użytkownika o określonej nazwie i zawartości. Wyjątek, jeśli content
przekracza 50 MB.
// Create a text file with the content "Hello, world!" DriveApp.createFile('New Text File', 'Hello, world!');
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | Nazwa nowego pliku. |
content | String | Treść nowego pliku. |
Powrót
File
– nowy plik.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
create File(name, content, mimeType)
Tworzy plik w katalogu głównym Dysku użytkownika z podaną nazwą, treścią i typem MIME. Wyjątek jest rzucany, jeśli 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
Nazwa | Typ | Opis |
---|---|---|
name | String | Nazwa nowego pliku. |
content | String | Treść nowego pliku. |
mime | String | Typ MIME nowego pliku. |
Powrót
File
– nowy plik.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
create Folder(name)
Tworzy folder o podanej nazwie w katalogu głównym Dysku użytkownika.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | Nazwa nowego folderu. |
Powrót
Folder
– nowy folder.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
create Shortcut(targetId)
Tworzy skrót do podanego identyfikatora elementu na Dysku i zwraca go.
Parametry
Nazwa | Typ | Opis |
---|---|---|
target | String | Identyfikator pliku lub folderu docelowego. |
Powrót
File
– nowy skrót.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
create Shortcut For Target Id And Resource Key(targetId, targetResourceKey)
Tworzy i zwraca skrót do podanego identyfikatora elementu i klucza zasobu na Dysku. Klucz zasobu to dodatkowy parametr, który musi zostać przekazany, 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
Nazwa | Typ | Opis |
---|---|---|
target | String | Identyfikator docelowego pliku lub folderu. |
target | String | Klucz zasobu docelowego pliku lub folderu. |
Powrót
File
– nowy skrót.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
enforce Single Parent(value)
Włącza lub wyłącza zachowanie enforceSingleParent dla wszystkich wywołań wpływających na elementy nadrzędne.
Więcej informacji znajdziesz w artykule Upraszczanie struktury folderów i modeli udostępniania na Dysku Google.
// Enables enforceSingleParent behavior for all calls affecting item parents. DriveApp.enforceSingleParent(true);
Parametry
Nazwa | Typ | Opis |
---|---|---|
value | Boolean | Nowy stan flagi enforceSingleParent. |
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/drive
get File By Id(id)
Pobiera plik o podanym identyfikatorze. 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
Nazwa | Typ | Opis |
---|---|---|
id | String | Identyfikator pliku. |
Powrót
File
– plik o podanym identyfikatorze.
Autoryzacja
Skrypty, które korzystają 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
get File By Id And Resource Key(id, resourceKey)
Pobiera plik o podanym identyfikatorze i kluczu zasobu. Klucze zasobów to dodatkowy parametr, który musi zostać przekazany, aby uzyskać dostęp do plików udostępnionych za pomocą linku.
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
Nazwa | Typ | Opis |
---|---|---|
id | String | Identyfikator pliku. |
resource | String | Klucz zasobu folderu. |
Powrót
File
– plik o podanym identyfikatorze.
Autoryzacja
Skrypty, które korzystają 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
get Files()
Pobiera kolekcję wszystkich plików na Dysku użytkownika.
Powrót
File
– kolekcja wszystkich plików na Dysku użytkownika.
Autoryzacja
Skrypty, które korzystają 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
get Files By Name(name)
Pobiera kolekcję wszystkich plików na Dysku użytkownika, które mają daną nazwę.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | Nazwa plików do znalezienia. |
Powrót
File
– zbiór wszystkich plików na Dysku użytkownika, które mają daną nazwę.
Autoryzacja
Skrypty, które korzystają 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
get Files By Type(mimeType)
Pobiera kolekcję wszystkich plików na Dysku użytkownika, które mają dany typ MIME.
Parametry
Nazwa | Typ | Opis |
---|---|---|
mime | String | Typ MIME plików do znalezienia. |
Powrót
File
– zbiór wszystkich plików na Dysku użytkownika, które mają dany typ MIME.
Autoryzacja
Skrypty, które korzystają 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
get Folder By Id(id)
Pobiera folder o podanym identyfikatorze. Wyjątek skryptu, jeśli folder nie istnieje lub użytkownik nie ma do niego dostępu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String | Identyfikator folderu. |
Powrót
Folder
– folder o podanym identyfikatorze.
Autoryzacja
Skrypty, które korzystają 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
get Folder By Id And Resource Key(id, resourceKey)
Pobiera folder o podanym identyfikatorze i kluczu zasobu. Klucze zasobów to dodatkowy parametr, który musi zostać przekazany, aby uzyskać dostęp do folderów udostępnionych za pomocą linku.
Wyjątek skryptu, jeśli folder nie istnieje lub użytkownik nie ma do niego dostępu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String | Identyfikator folderu. |
resource | String | Klucz zasobu folderu. |
Powrót
Folder
– folder o podanym identyfikatorze.
Autoryzacja
Skrypty, które korzystają 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
get Folders()
Pobiera kolekcję wszystkich folderów na Dysku użytkownika.
Powrót
Folder
– kolekcja wszystkich folderów na Dysku użytkownika.
Autoryzacja
Skrypty, które korzystają 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
get Folders By Name(name)
Pobiera kolekcję wszystkich folderów na Dysku użytkownika, które mają podaną nazwę.
Parametry
Nazwa | Typ | Opis |
---|---|---|
name | String | Nazwa folderów do znalezienia. |
Powrót
Folder
– zbiór wszystkich folderów na Dysku użytkownika, które mają daną nazwę.
Autoryzacja
Skrypty, które korzystają 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
get Root Folder()
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, które korzystają 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
get Storage Limit()
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, które korzystają 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
get Storage Used()
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 aktualnie przechowuje na Dysku.
Autoryzacja
Skrypty, które korzystają 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
get Trashed Files()
Pobiera kolekcję 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
File
– kolekcja plików w koszu.
Autoryzacja
Skrypty, które korzystają 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
get Trashed Folders()
Pobiera kolekcję wszystkich folderów znajdujących się 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
Folder
– kolekcja folderów w koszu.
Autoryzacja
Skrypty, które korzystają 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
search Files(params)
Pobiera kolekcję wszystkich plików na Dysku użytkownika, które pasują do podanych kryteriów wyszukiwania. Kryteria wyszukiwania zostały opisane w dokumentacji pakietu SDK Dysku Google. Pamiętaj, że usługa Dysk używa interfejsu Drive API w wersji 2, a niektóre pola zapytania różnią się od wersji 3. Zapoznaj się z różnicami między polami w wersji 2 a 3.
Argument params
to ciąg znaków zapytania, który może zawierać wartości ciągu znaków, więc należy poprawnie stosować znaki cudzysłowe (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
Nazwa | Typ | Opis |
---|---|---|
params | String | kryteria wyszukiwania opisane w dokumentacji pakietu SDK Dysku Google. |
Powrót
File
– zbiór wszystkich plików na Dysku użytkownika, które spełniają kryteria wyszukiwania.
Autoryzacja
Skrypty, które korzystają 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
search Folders(params)
Pobiera kolekcję wszystkich folderów na Dysku użytkownika, które pasują do podanych kryteriów wyszukiwania. Kryteria wyszukiwania zostały opisane w dokumentacji pakietu SDK Dysku Google. Pamiętaj, że usługa Dysk używa interfejsu Drive API w wersji 2, a niektóre pola zapytania różnią się od wersji 3. Zapoznaj się z różnicami między polami w wersji 2 a 3.
Argument params
to ciąg znaków zapytania, który może zawierać wartości ciągu znaków, więc należy poprawnie ujęć cudzysłowy (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
Nazwa | Typ | Opis |
---|---|---|
params | String | kryteria wyszukiwania opisane w dokumentacji pakietu SDK Dysku Google. |
Powrót
Folder
– kolekcja wszystkich folderów na Dysku użytkownika, które spełniają kryteria wyszukiwania.
Autoryzacja
Skrypty, które korzystają 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