Ta usługa pozwala skryptom tworzyć, znajdować i modyfikować pliki oraz foldery na Dysku Google.
Jeśli Twój skrypt używa standardowego projektu Cloud zamiast domyślnego projektu Cloud, musisz ręcznie włączyć interfejs Drive API. W standardowym projekcie Cloud włącz interfejs Drive API:
Włączanie interfejsu Drive API
Poniższy przykładowy kod pokazuje, jak zapisać nazwy poszczególnych plików w folderze Mój dysk użytkownika:// 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());
}
Zajęcia
Nazwa | Krótki opis |
---|---|
Access | Wyliczenie 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. |
DriveApp | Umożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików i folderów na Dysku Google. |
File | Plik na Dysku Google. |
FileIterator | iterator, który pozwala skryptom na wykonywanie iteracji na potencjalnie duży zbiór plików. |
Folder | Folder na Dysku Google. |
FolderIterator | Obiekt umożliwiający iterację skryptu na potencjalnie duży zbiór folderów. |
Permission | Wyliczenie symbolizujące uprawnienia użytkownikom, którzy mają dostęp do pliku lub folderu, oraz innym użytkownikom, którym jednoznacznie przyznano dostęp. |
User | Użytkownik powiązany z plikiem na Dysku Google. |
Access
Właściwości
Usługa | Typ | Opis |
---|---|---|
ANYONE | Enum | Każdy użytkownik internetu może znajdować te pliki i uzyskiwać do nich dostęp. |
ANYONE_WITH_LINK | Enum | Każda osoba mająca link może uzyskiwać dostęp. |
DOMAIN | Enum | Osoby w Twojej domenie mogą znajdować i uzyskiwać dostęp. |
DOMAIN_WITH_LINK | Enum | Osoby w Twojej domenie mające link mogą uzyskiwać dostęp. |
PRIVATE | Enum | Dostęp mogą uzyskać tylko osoby z uprawnieniami przyznanymi wprost. |
DriveApp
Właściwości
Usługa | Typ | Opis |
---|---|---|
Access | Access | Wyliczenie 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. |
Permission | Permission | Wyliczenie 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
Metoda | Zwracany typ | Krótki opis |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | Wznowienie iteracji pliku przy użyciu tokena kontynuacji z poprzedniego iteratora. |
continueFolderIterator(continuationToken) | FolderIterator | Wznowienie iteracji folderu przy użyciu tokena kontynuacji z poprzedniego iteratora. |
createFile(blob) | File | Tworzy plik w katalogu głównym Dysku użytkownika na podstawie określonych Blob dowolnych danych. |
createFile(name, content) | File | Tworzy plik tekstowy w katalogu głównym Dysku użytkownika o podanej nazwie i zawartości. |
createFile(name, content, mimeType) | File | Tworzy plik w katalogu głównym Dysku użytkownika o podanej nazwie, treści i typie MIME. |
createFolder(name) | Folder | Powoduje utworzenie folderu głównego na Dysku użytkownika o podanej nazwie. |
createShortcut(targetId) | File | Tworzy skrót do podanego identyfikatora elementu na Dysku i zwraca go. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Tworzy skrót do podanego elementu elementu na Dysku i klucza zasobu, a następnie go zwraca. |
enforceSingleParent(value) | void | Włącza lub wyłącza egzekwowanie funkcji SingleSingle dla wszystkich wywołań dotyczących elementów nadrzędnych elementu. |
getFileById(id) | File | Pobiera plik o podanym identyfikatorze. |
getFileByIdAndResourceKey(id, resourceKey) | File | Pobiera plik o podanym identyfikatorze i kluczu zasobu. |
getFiles() | FileIterator | Pobiera zbiór wszystkich plików na Dysku użytkownika. |
getFilesByName(name) | FileIterator | Pobiera zbiór wszystkich plików na Dysku użytkownika, które mają określoną nazwę. |
getFilesByType(mimeType) | FileIterator | Pobiera zbiór wszystkich plików na Dysku użytkownika, które mają określony typ MIME. |
getFolderById(id) | Folder | Pobiera folder o podanym identyfikatorze. |
getFolderByIdAndResourceKey(id, resourceKey) | Folder | Pobiera folder o podanym identyfikatorze i kluczu zasobu. |
getFolders() | FolderIterator | Pobiera kolekcję wszystkich folderów na Dysku użytkownika. |
getFoldersByName(name) | FolderIterator | Pobiera kolekcję wszystkich folderów na Dysku użytkownika o określonej nazwie. |
getRootFolder() | Folder | Pobiera folder w katalogu głównym Dysku użytkownika. |
getStorageLimit() | Integer | Pobiera liczbę bajtów, które użytkownik może przechowywać na Dysku. |
getStorageUsed() | Integer | Pobiera liczbę bajtów przechowywanych przez użytkownika na Dysku. |
getTrashedFiles() | FileIterator | Pobiera zbiór wszystkich plików znajdujących się w koszu na Dysku użytkownika. |
getTrashedFolders() | FolderIterator | Pobiera kolekcję wszystkich folderów w koszu na Dysku użytkownika. |
searchFiles(params) | FileIterator | Pobiera zbiór wszystkich plików na Dysku użytkownika, które spełniają określone kryteria wyszukiwania. |
searchFolders(params) | FolderIterator | Pobiera zbiór wszystkich folderów na Dysku użytkownika, które spełniają określone kryteria wyszukiwania. |
File
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addCommenter(emailAddress) | File | Dodaj danego użytkownika do listy komentujących (File ). |
addCommenter(user) | File | Dodaj danego użytkownika do listy komentujących (File ). |
addCommenters(emailAddresses) | File | Dodaj daną tablicę użytkowników do listy komentujących element File . |
addEditor(emailAddress) | File | Dodaje danego użytkownika do listy edytorów elementu File . |
addEditor(user) | File | Dodaje danego użytkownika do listy edytorów elementu File . |
addEditors(emailAddresses) | File | Dodaje podaną tablicę użytkowników do listy edytorów obiektu File . |
addViewer(emailAddress) | File | Dodaje danego użytkownika do listy gogli File . |
addViewer(user) | File | Dodaje danego użytkownika do listy gogli File . |
addViewers(emailAddresses) | File | Dodaje podaną tablicę użytkowników do listy widzów obiektu File . |
getAccess(email) | Permission | Pobiera uprawnienia przyznane danemu użytkownikowi. |
getAccess(user) | Permission | Pobiera uprawnienia przyznane danemu użytkownikowi. |
getAs(contentType) | Blob | Zwraca dane wewnątrz tego obiektu w postaci obiektu blob przekonwertowanego na określony typ treści. |
getBlob() | Blob | Zwraca dane wewnątrz tego obiektu jako obiekt blob. |
getDateCreated() | Date | Pobiera datę utworzenia zasobu File . |
getDescription() | String | Pobiera opis elementu File . |
getDownloadUrl() | String | Pobiera adres URL, którego można użyć do pobrania pliku. |
getEditors() | User[] | Pobiera listę edytorów na koncie File . |
getId() | String | Pobiera identyfikator File . |
getLastUpdated() | Date | Pobiera datę ostatniej aktualizacji elementu File . |
getMimeType() | String | Pobiera typ MIME pliku. |
getName() | String | Pobiera nazwę File . |
getOwner() | User | Pobiera właściciela pliku. |
getParents() | FolderIterator | Pobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnym folderu File . |
getResourceKey() | String | Pobiera klucz zasobu File , który jest wymagany do uzyskania dostępu do elementów udostępnionych przy użyciu linku. |
getSecurityUpdateEligible() | Boolean | Określa, czy File może stosować aktualizację zabezpieczeń, która wymaga dostępu do zasobu za pomocą linku. |
getSecurityUpdateEnabled() | Boolean | Określa, czy to File wymaga dostępu do zasobu za pomocą linku. |
getSharingAccess() | Access | Określa, do jakiej klasy użytkowników oprócz File mają mieć dostęp inni użytkownicy. |
getSharingPermission() | Permission | Pobiera uprawnienia przyznawane użytkownikom, którzy mają dostęp do File , oraz wszystkie osoby, którym jednoznacznie przyznano dostęp. |
getSize() | Integer | Pobiera liczbę bajtów przechowywanych na Dysku: File . |
getTargetId() | String | Jeśli jest to skrót, zwraca identyfikator elementu, do którego prowadzi. |
getTargetMimeType() | String | Jeśli jest to skrót, zwraca typ MIME elementu, do którego prowadzi. |
getTargetResourceKey() | String | Jeśli plik jest skrótem, zwraca klucz zasobu wskazanego elementu. |
getThumbnail() | Blob | Pobiera miniaturę pliku lub null , jeśli nie ma miniatury. |
getUrl() | String | Pobiera adres URL, którego można użyć do otwarcia elementu File w aplikacji Google, takiej jak Dysk czy Dokumenty. |
getViewers() | User[] | Pobiera listę widzów i komentujących ten element (File ). |
isShareableByEditors() | Boolean | Określa, czy użytkownicy z uprawnieniami do edycji elementu File mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia. |
isStarred() | Boolean | Określa, czy plik File został oznaczony na Dysku użytkownika. |
isTrashed() | Boolean | Określa, czy plik File znajduje się w koszu na Dysku użytkownika. |
makeCopy() | File | Tworzy kopię pliku. |
makeCopy(destination) | File | Tworzy kopię pliku z katalogu docelowego. |
makeCopy(name) | File | Tworzy kopię pliku i nadaje mu nazwę. |
makeCopy(name, destination) | File | Tworzy kopię pliku w katalogu docelowym i nadaje mu nazwę. |
moveTo(destination) | File | Przenosi ten element do podanego folderu docelowego. |
removeCommenter(emailAddress) | File | Usunięcie użytkownika z listy komentujących: File . |
removeCommenter(user) | File | Usunięcie użytkownika z listy komentujących: File . |
removeEditor(emailAddress) | File | Usunięcie tego użytkownika z listy edytorów File . |
removeEditor(user) | File | Usunięcie tego użytkownika z listy edytorów File . |
removeViewer(emailAddress) | File | Usunięcie użytkownika z listy widzów i komentujących w przypadku File . |
removeViewer(user) | File | Usunięcie użytkownika z listy widzów i komentujących w przypadku File . |
revokePermissions(emailAddress) | File | Cofnie dostęp do File przyznany danemu użytkownikowi. |
revokePermissions(user) | File | Cofnie dostęp do File przyznany danemu użytkownikowi. |
setContent(content) | File | Zastępuje zawartość pliku danym elementem. |
setDescription(description) | File | Ustawia opis elementu File . |
setName(name) | File | Ustawia nazwę elementu File . |
setOwner(emailAddress) | File | Zmienia właściciela elementu File . |
setOwner(user) | File | Zmienia właściciela elementu File . |
setSecurityUpdateEnabled(enabled) | File | Określa, czy File wymaga klucza dostępu do zasobu, gdy jest udostępniany za pomocą linku. |
setShareableByEditors(shareable) | File | Określa, czy użytkownicy z uprawnieniami do edycji elementu File mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia. |
setSharing(accessType, permissionType) | File | Określa klasy użytkowników, którzy mają mieć dostęp do File , i uprawnienia przyznawane tym użytkownikom oprócz poszczególnych użytkowników, którzy otrzymali bezpośrednie zezwolenie. |
setStarred(starred) | File | Określa, czy plik File jest oznaczony gwiazdką na Dysku użytkownika. |
setTrashed(trashed) | File | Określa, czy plik File znajduje się w koszu na Dysku użytkownika. |
FileIterator
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getContinuationToken() | String | Pobiera token, który można później użyć do wznowienia tego wystąpienia. |
hasNext() | Boolean | Określa, czy wywołanie metody next() spowoduje zwrócenie elementu. |
next() | File | Pobiera następny element ze zbioru plików lub folderów. |
Folder
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addEditor(emailAddress) | Folder | Dodaje danego użytkownika do listy edytorów elementu Folder . |
addEditor(user) | Folder | Dodaje danego użytkownika do listy edytorów elementu Folder . |
addEditors(emailAddresses) | Folder | Dodaje podaną tablicę użytkowników do listy edytorów obiektu Folder . |
addViewer(emailAddress) | Folder | Dodaje danego użytkownika do listy gogli Folder . |
addViewer(user) | Folder | Dodaje danego użytkownika do listy gogli Folder . |
addViewers(emailAddresses) | Folder | Dodaje podaną tablicę użytkowników do listy widzów obiektu Folder . |
createFile(blob) | File | Tworzy plik w bieżącym folderze na podstawie danych Blob dowolnych danych. |
createFile(name, content) | File | Tworzy w bieżącym folderze plik tekstowy o podanej nazwie i podanej zawartości. |
createFile(name, content, mimeType) | File | Tworzy w bieżącym folderze plik o podanej nazwie, zawartości i typie MIME. |
createFolder(name) | Folder | Tworzy folder w bieżącym folderze o podanej nazwie. |
createShortcut(targetId) | File | Tworzy skrót do podanego identyfikatora elementu na Dysku i zwraca go. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Tworzy skrót do podanego elementu elementu na Dysku i klucza zasobu, a następnie go zwraca. |
getAccess(email) | Permission | Pobiera uprawnienia przyznane danemu użytkownikowi. |
getAccess(user) | Permission | Pobiera uprawnienia przyznane danemu użytkownikowi. |
getDateCreated() | Date | Pobiera datę utworzenia zasobu Folder . |
getDescription() | String | Pobiera opis elementu Folder . |
getEditors() | User[] | Pobiera listę edytorów na koncie Folder . |
getFiles() | FileIterator | Pobiera zbiór wszystkich plików podrzędnych bieżącego folderu. |
getFilesByName(name) | FileIterator | Pobiera kolekcję wszystkich plików podrzędnych bieżącego folderu o podanej nazwie. |
getFilesByType(mimeType) | FileIterator | Pobiera zbiór wszystkich plików, które są elementami podrzędnymi bieżącego folderu i mają dany typ MIME. |
getFolders() | FolderIterator | Pobiera kolekcję wszystkich folderów podrzędnych bieżącego folderu. |
getFoldersByName(name) | FolderIterator | Pobiera kolekcję wszystkich folderów podrzędnych folderu bieżącego o podanej nazwie. |
getId() | String | Pobiera identyfikator Folder . |
getLastUpdated() | Date | Pobiera datę ostatniej aktualizacji elementu Folder . |
getName() | String | Pobiera nazwę Folder . |
getOwner() | User | Pobiera właściciela tego elementu (Folder ). |
getParents() | FolderIterator | Pobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnym folderu Folder . |
getResourceKey() | String | Pobiera klucz zasobu Folder , który jest wymagany do uzyskania dostępu do elementów udostępnionych przy użyciu linku. |
getSecurityUpdateEligible() | Boolean | Określa, czy Folder może stosować aktualizację zabezpieczeń, która wymaga dostępu do zasobu za pomocą linku. |
getSecurityUpdateEnabled() | Boolean | Określa, czy to Folder wymaga dostępu do zasobu za pomocą linku. |
getSharingAccess() | Access | Określa, do jakiej klasy użytkowników oprócz Folder mają mieć dostęp inni użytkownicy. |
getSharingPermission() | Permission | Pobiera uprawnienia przyznawane użytkownikom, którzy mają dostęp do Folder , oraz wszystkie osoby, którym jednoznacznie przyznano dostęp. |
getSize() | Integer | Pobiera liczbę bajtów przechowywanych na Dysku: Folder . |
getUrl() | String | Pobiera adres URL, którego można użyć do otwarcia elementu Folder w aplikacji Google, takiej jak Dysk czy Dokumenty. |
getViewers() | User[] | Pobiera listę widzów i komentujących ten element (Folder ). |
isShareableByEditors() | Boolean | Określa, czy użytkownicy z uprawnieniami do edycji elementu Folder mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia. |
isStarred() | Boolean | Określa, czy plik Folder został oznaczony na Dysku użytkownika. |
isTrashed() | Boolean | Określa, czy plik Folder znajduje się w koszu na Dysku użytkownika. |
moveTo(destination) | Folder | Przenosi ten element do podanego folderu docelowego. |
removeEditor(emailAddress) | Folder | Usunięcie tego użytkownika z listy edytorów Folder . |
removeEditor(user) | Folder | Usunięcie tego użytkownika z listy edytorów Folder . |
removeViewer(emailAddress) | Folder | Usunięcie użytkownika z listy widzów i komentujących w przypadku Folder . |
removeViewer(user) | Folder | Usunięcie użytkownika z listy widzów i komentujących w przypadku Folder . |
revokePermissions(emailAddress) | Folder | Cofnie dostęp do Folder przyznany danemu użytkownikowi. |
revokePermissions(user) | Folder | Cofnie dostęp do Folder przyznany danemu użytkownikowi. |
searchFiles(params) | FileIterator | Pobiera zbiór wszystkich plików podrzędnych bieżącego folderu, które pasują do podanych kryteriów wyszukiwania. |
searchFolders(params) | FolderIterator | Pobiera zbiór wszystkich folderów podrzędnych bieżącego folderu, które pasują do podanych kryteriów wyszukiwania. |
setDescription(description) | Folder | Ustawia opis elementu Folder . |
setName(name) | Folder | Ustawia nazwę elementu Folder . |
setOwner(emailAddress) | Folder | Zmienia właściciela elementu Folder . |
setOwner(user) | Folder | Zmienia właściciela elementu Folder . |
setSecurityUpdateEnabled(enabled) | Folder | Określa, czy Folder wymaga klucza dostępu do zasobu, gdy jest udostępniany za pomocą linku. |
setShareableByEditors(shareable) | Folder | Określa, czy użytkownicy z uprawnieniami do edycji elementu Folder mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia. |
setSharing(accessType, permissionType) | Folder | Określa klasy użytkowników, którzy mają mieć dostęp do Folder , i uprawnienia przyznawane tym użytkownikom oprócz poszczególnych użytkowników, którzy otrzymali bezpośrednie zezwolenie. |
setStarred(starred) | Folder | Określa, czy plik Folder jest oznaczony gwiazdką na Dysku użytkownika. |
setTrashed(trashed) | Folder | Określa, czy plik Folder znajduje się w koszu na Dysku użytkownika. |
FolderIterator
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getContinuationToken() | String | Pobiera token, który można później użyć do wznowienia tego wystąpienia. |
hasNext() | Boolean | Określa, czy wywołanie metody next() spowoduje zwrócenie elementu. |
next() | Folder | Pobiera następny element ze zbioru plików lub folderów. |
Permission
Właściwości
Usługa | Typ | Opis |
---|---|---|
VIEW | Enum | Użytkownicy, którzy mają dostęp do pliku lub folderu, mogą go tylko wyświetlić lub skopiować. |
EDIT | Enum | Użytkownicy, którzy mają dostęp do pliku lub folderu, mogą go edytować. |
COMMENT | Enum | Użytkownicy, którzy mają dostęp do pliku lub folderu, mogą tylko go wyświetlać, kopiować i komentować. |
OWNER | Enum | Plik lub folder jest własnością użytkownika. |
ORGANIZER | Enum | Użytkownicy, którzy mogą porządkować pliki i foldery na dysku współdzielonym. |
FILE_ORGANIZER | Enum | Użytkownicy, którzy mogą edytować, usuwać i przenosić treści na dysku współdzielonym. |
NONE | Enum | Użytkownik nie ma żadnych uprawnień do tego pliku lub folderu. |
User
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getDomain() | String | Pobiera nazwę domeny powiązaną z kontem użytkownika. |
getEmail() | String | Pobiera adres e-mail użytkownika. |
getName() | String | Pobiera nazwę użytkownika. |
getPhotoUrl() | String | Pobiera adres URL zdjęcia użytkownika. |