Ta usługa umożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików oraz folderów w Dysk Google.
Jeśli skrypt korzysta z parametru standardowy projekt 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 zapisywać nazwy poszczególnych plików w plikach Folder Mój 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());
}
Zajęcia
Nazwa | Krótki opis |
---|---|
Access | Enum 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. |
DriveApp | Zezwala skryptom na tworzenie, znajdowanie i modyfikowanie plików oraz folderów na Dysku Google. |
File | plik na Dysku Google, |
FileIterator | Iterator, który umożliwia skryptom iterację na potencjalnie dużym zbiorze plików. |
Folder | Folder na Dysku Google. |
FolderIterator | Obiekt, który umożliwia skryptom iterację na potencjalnie dużej kolekcji folderów. |
Permission | Enum reprezentujące uprawnienia przyznane użytkownikom, którzy mają dostęp do pliku lub folderu: wszystkim użytkownikom, którym wprost przyznano dostęp. |
User | Użytkownik powiązany z plikiem na Dysku Google. |
Access
Właściwości
Właściwość | Typ | Opis |
---|---|---|
ANYONE | Enum | Każdy użytkownik internetu może znajdować i uzyskiwać dostęp. |
ANYONE_WITH_LINK | Enum | Każdy użytkownik mający link może uzyskać 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
Właściwość | Typ | Opis |
---|---|---|
Access | Access | Enum 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. |
Permission | Permission | Enum 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
Metoda | Zwracany typ | Krótki opis |
---|---|---|
continueFileIterator(continuationToken) | FileIterator | Wznawia iterację pliku przy użyciu tokena kontynuacji z poprzedniego iteratora. |
continueFolderIterator(continuationToken) | FolderIterator | Wznawia iterację folderu przy użyciu tokena kontynuacji z poprzedniego iteracji. |
createFile(blob) | File | Tworzy plik w katalogu głównym Dysku użytkownika na podstawie wybranych danych (Blob ) |
createFile(name, content) | File | Tworzy plik tekstowy o podanej nazwie i zawartości w katalogu głównym Dysku użytkownika. |
createFile(name, content, mimeType) | File | Tworzy plik o podanej nazwie, zawartości i typie MIME w katalogu głównym Dysku użytkownika. |
createFolder(name) | Folder | Tworzy folder o podanej nazwie w katalogu głównym Dysku użytkownika. |
createShortcut(targetId) | File | Tworzy skrót do podanego identyfikatora elementu na Dysku i zwraca ten identyfikator. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Tworzy skrót do podanego identyfikatora elementu na Dysku i klucza zasobu i zwraca ten skrót. |
enforceSingleParent(value) | void | Włącza lub wyłącza zachowanie forceSingleParent w przypadku wszystkich wywołań mających wpływ na elementy nadrzędne. |
getFileById(id) | File | Pobiera plik o podanym identyfikatorze. |
getFileByIdAndResourceKey(id, resourceKey) | File | Pobiera plik o podanym identyfikatorze i kluczu zasobu. |
getFiles() | FileIterator | Pobiera kolekcję wszystkich plików na Dysku użytkownika. |
getFilesByName(name) | FileIterator | Pobiera kolekcję wszystkich plików na Dysku użytkownika o podanej nazwie. |
getFilesByType(mimeType) | FileIterator | Pobiera kolekcję wszystkich plików z Dysku użytkownika o podanym typie 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 podanej nazwie. |
getRootFolder() | Folder | Pobiera folder znajdujący się 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, które użytkownik obecnie przechowuje na Dysku. |
getTrashedFiles() | FileIterator | Pobiera kolekcję wszystkich plików w koszu Dysku użytkownika. |
getTrashedFolders() | FolderIterator | Pobiera kolekcję wszystkich folderów w koszu Dysku użytkownika. |
searchFiles(params) | FileIterator | Pobiera zbiór wszystkich plików na Dysku użytkownika, które pasują do zapytania kryteria. |
searchFolders(params) | FolderIterator | Pobiera zbiór wszystkich folderów na Dysku użytkownika, które pasują do zapytania kryteria. |
File
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addCommenter(emailAddress) | File | Dodaj danego użytkownika do listy komentujących zasobu File . |
addCommenter(user) | File | Dodaj danego użytkownika do listy komentujących zasobu File . |
addCommenters(emailAddresses) | File | Dodaj podaną tablicę użytkowników do listy komentujących obiektu File . |
addEditor(emailAddress) | File | Dodaje danego użytkownika do listy edytorów zasobu File . |
addEditor(user) | File | Dodaje danego użytkownika do listy edytorów zasobu File . |
addEditors(emailAddresses) | File | Dodaje podaną tablicę użytkowników do listy edytorów zasobu File . |
addViewer(emailAddress) | File | Dodaje danego użytkownika do listy przeglądających w: File . |
addViewer(user) | File | Dodaje danego użytkownika do listy przeglądających w: File . |
addViewers(emailAddresses) | File | Dodaje podaną tablicę użytkowników do listy przeglądających obiekt File . |
getAccess(email) | Permission | Pobiera uprawnienie przyznane danemu użytkownikowi. |
getAccess(user) | Permission | Pobiera uprawnienie przyznane danemu użytkownikowi. |
getAs(contentType) | Blob | Zwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści. |
getBlob() | Blob | Zwraca dane wewnątrz tego obiektu jako obiekt blob. |
getDateCreated() | Date | Otrzymuje datę utworzenia elementu 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 elementu File . |
getId() | String | Pobiera identyfikator elementu File . |
getLastUpdated() | Date | Pobiera datę ostatniej aktualizacji urządzenia File . |
getMimeType() | String | Pobiera typ MIME pliku. |
getName() | String | Pobiera nazwę elementu File . |
getOwner() | User | Pobiera właściciela pliku. |
getParents() | FolderIterator | Pobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnymi folderu File . |
getResourceKey() | String | Pobiera klucz zasobu File wymagany, aby uzyskać dostęp do elementów, które
zostały udostępnione za pomocą linku. |
getSecurityUpdateEligible() | Boolean | Określa, czy to urządzenie File kwalifikuje się do stosowania aktualizacji zabezpieczeń, która
wymaga klucza zasobu, aby uzyskać dostęp, gdy jest on udostępniany za pomocą linku. |
getSecurityUpdateEnabled() | Boolean | Określa, czy File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest
udostępnione za pomocą linku. |
getSharingAccess() | Access | Pobiera klasę użytkowników, którzy mają dostęp do: File (oprócz poszczególnych osób)
użytkownikom, którym wprost przyznano dostęp. |
getSharingPermission() | Permission | pobiera uprawnienia przyznane użytkownikom, którzy mają dostęp do: File ,
oprócz poszczególnych użytkowników, którym wprost przyznano dostęp. |
getSize() | Integer | Pobiera liczbę bajtów używanych do przechowywania elementu File na Dysku. |
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 elementu, do którego prowadzi. |
getThumbnail() | Blob | Pobiera obraz miniatury pliku lub null , jeśli miniatura nie istnieje. |
getUrl() | String | Uzyskuje adres URL, którego można użyć do otwarcia pliku File w aplikacji Google, np.
Dysk lub Dokumenty. |
getViewers() | User[] | Pobiera listę przeglądających i komentujących dla elementu File . |
isShareableByEditors() | Boolean | Określa, czy użytkownicy z uprawnieniami do edycji zasobu File mogą
udostępnić innym użytkownikom lub zmienić uprawnienia. |
isStarred() | Boolean | Określa, czy element File został oznaczony gwiazdką na Dysku użytkownika. |
isTrashed() | Boolean | Określa, czy File znajduje się w koszu na Dysku użytkownika. |
makeCopy() | File | Tworzy kopię pliku. |
makeCopy(destination) | File | Tworzy kopię pliku w katalogu docelowym. |
makeCopy(name) | File | Tworzy kopię pliku i nadaje mu nazwę (nadać mu podaną nazwę). |
makeCopy(name, destination) | File | Tworzy kopię pliku w katalogu docelowym i nadaje mu nazwę na podstawie podanej nazwy. |
moveTo(destination) | File | Przenosi ten element do podanego folderu docelowego. |
removeCommenter(emailAddress) | File | Usuwa dane użytkownika z listy komentujących do: File . |
removeCommenter(user) | File | Usuwa dane użytkownika z listy komentujących do: File . |
removeEditor(emailAddress) | File | Usuwa danego użytkownika z listy edytorów zasobu File . |
removeEditor(user) | File | Usuwa danego użytkownika z listy edytorów zasobu File . |
removeViewer(emailAddress) | File | Usuwa dane użytkownika z listy przeglądających i komentujących File . |
removeViewer(user) | File | Usuwa dane użytkownika z listy przeglądających i komentujących File . |
revokePermissions(emailAddress) | File | Odbierze uprawnienia File przyznane danemu użytkownikowi. |
revokePermissions(user) | File | Odbierze uprawnienia File przyznane danemu użytkownikowi. |
setContent(content) | File | Powoduje zastąpienie zawartości pliku danym zamiennikiem. |
setDescription(description) | File | Ustawia opis elementu File . |
setName(name) | File | Określa nazwę elementu File . |
setOwner(emailAddress) | File | Zmienia właściciela: File . |
setOwner(user) | File | Zmienia właściciela: File . |
setSecurityUpdateEnabled(enabled) | File | Określa, czy File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest
udostępnione za pomocą linku. |
setShareableByEditors(shareable) | File | Określa, czy użytkownicy z uprawnieniami do edycji w elemencie File mogą udostępniać treści
innym użytkownikom lub zmienić uprawnienia. |
setSharing(accessType, permissionType) | File | Określa, które klasy użytkowników mają dostęp do elementu File i jakie uprawnienia
użytkownicy, którym przyznano dostęp wprost. |
setStarred(starred) | File | Określa, czy element File jest oznaczony gwiazdką na Dysku użytkownika. |
setTrashed(trashed) | File | Określa, czy File znajduje się w koszu Dysku użytkownika. |
FileIterator
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getContinuationToken() | String | Pobiera token, którego można użyć do wznowienia tej iteracji w późniejszym czasie. |
hasNext() | Boolean | Określa, czy wywołanie funkcji next() zwróci produkt. |
next() | File | Pobiera następny element w kolekcji plików lub folderów. |
Folder
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addEditor(emailAddress) | Folder | Dodaje danego użytkownika do listy edytorów zasobu Folder . |
addEditor(user) | Folder | Dodaje danego użytkownika do listy edytorów zasobu Folder . |
addEditors(emailAddresses) | Folder | Dodaje podaną tablicę użytkowników do listy edytorów zasobu Folder . |
addViewer(emailAddress) | Folder | Dodaje danego użytkownika do listy przeglądających w: Folder . |
addViewer(user) | Folder | Dodaje danego użytkownika do listy przeglądających w: Folder . |
addViewers(emailAddresses) | Folder | Dodaje podaną tablicę użytkowników do listy przeglądających obiekt Folder . |
createFile(blob) | File | Tworzy plik w bieżącym folderze na podstawie wybranych danych (Blob ). |
createFile(name, content) | File | Tworzy w bieżącym folderze plik tekstowy o podanej nazwie i 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 o podanej nazwie w bieżącym folderze. |
createShortcut(targetId) | File | Tworzy skrót do podanego identyfikatora elementu na Dysku i zwraca ten identyfikator. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | Tworzy skrót do podanego identyfikatora elementu na Dysku i klucza zasobu i zwraca ten skrót. |
getAccess(email) | Permission | Pobiera uprawnienie przyznane danemu użytkownikowi. |
getAccess(user) | Permission | Pobiera uprawnienie przyznane danemu użytkownikowi. |
getDateCreated() | Date | Otrzymuje datę utworzenia elementu Folder . |
getDescription() | String | Pobiera opis elementu Folder . |
getEditors() | User[] | Pobiera listę edytorów elementu Folder . |
getFiles() | FileIterator | Pobiera kolekcję wszystkich plików podrzędnych względem bieżącego folderu. |
getFilesByName(name) | FileIterator | Pobiera kolekcję wszystkich plików, które są podrzędne względem bieżącego folderu i mają podaną nazwę. |
getFilesByType(mimeType) | FileIterator | Pobiera kolekcję wszystkich plików podrzędnych względem bieżącego folderu i o podanym typie MIME. |
getFolders() | FolderIterator | Pobiera kolekcję wszystkich folderów podrzędnych folderu bieżącego. |
getFoldersByName(name) | FolderIterator | Pobiera kolekcję wszystkich folderów, które są folderami podrzędnymi bieżącego folderu i mają podaną nazwę. |
getId() | String | Pobiera identyfikator elementu Folder . |
getLastUpdated() | Date | Pobiera datę ostatniej aktualizacji urządzenia Folder . |
getName() | String | Pobiera nazwę elementu Folder . |
getOwner() | User | Pobiera właściciela tego elementu (Folder ). |
getParents() | FolderIterator | Pobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnymi folderu Folder . |
getResourceKey() | String | Pobiera klucz zasobu Folder wymagany, aby uzyskać dostęp do elementów, które
zostały udostępnione za pomocą linku. |
getSecurityUpdateEligible() | Boolean | Określa, czy to urządzenie Folder kwalifikuje się do stosowania aktualizacji zabezpieczeń, która
wymaga klucza zasobu, aby uzyskać dostęp, gdy jest on udostępniany za pomocą linku. |
getSecurityUpdateEnabled() | Boolean | Określa, czy Folder wymaga klucza zasobu, aby uzyskać dostęp, gdy jest
udostępnione za pomocą linku. |
getSharingAccess() | Access | Pobiera klasę użytkowników, którzy mają dostęp do: Folder (oprócz poszczególnych osób)
użytkownikom, którym wprost przyznano dostęp. |
getSharingPermission() | Permission | pobiera uprawnienia przyznane użytkownikom, którzy mają dostęp do: Folder ,
oprócz poszczególnych użytkowników, którym wprost przyznano dostęp. |
getSize() | Integer | Pobiera liczbę bajtów używanych do przechowywania elementu Folder na Dysku. |
getUrl() | String | Uzyskuje adres URL, którego można użyć do otwarcia pliku Folder w aplikacji Google, np.
Dysk lub Dokumenty. |
getViewers() | User[] | Pobiera listę przeglądających i komentujących dla elementu Folder . |
isShareableByEditors() | Boolean | Określa, czy użytkownicy z uprawnieniami do edycji zasobu Folder mogą
udostępnić innym użytkownikom lub zmienić uprawnienia. |
isStarred() | Boolean | Określa, czy element Folder został oznaczony gwiazdką na Dysku użytkownika. |
isTrashed() | Boolean | Określa, czy Folder znajduje się w koszu na Dysku użytkownika. |
moveTo(destination) | Folder | Przenosi ten element do podanego folderu docelowego. |
removeEditor(emailAddress) | Folder | Usuwa danego użytkownika z listy edytorów zasobu Folder . |
removeEditor(user) | Folder | Usuwa danego użytkownika z listy edytorów zasobu Folder . |
removeViewer(emailAddress) | Folder | Usuwa dane użytkownika z listy przeglądających i komentujących Folder . |
removeViewer(user) | Folder | Usuwa dane użytkownika z listy przeglądających i komentujących Folder . |
revokePermissions(emailAddress) | Folder | Odbierze uprawnienia Folder przyznane danemu użytkownikowi. |
revokePermissions(user) | Folder | Odbierze uprawnienia Folder przyznane danemu użytkownikowi. |
searchFiles(params) | FileIterator | Pobiera zbiór wszystkich plików podrzędnych względem bieżącego folderu i które pasują do danego wyszukiwania kryteria. |
searchFolders(params) | FolderIterator | Pobiera zbiór wszystkich folderów podrzędnych bieżącego folderu i pasujących do podanego wyszukiwania kryteria. |
setDescription(description) | Folder | Ustawia opis elementu Folder . |
setName(name) | Folder | Określa nazwę elementu Folder . |
setOwner(emailAddress) | Folder | Zmienia właściciela: Folder . |
setOwner(user) | Folder | Zmienia właściciela: Folder . |
setSecurityUpdateEnabled(enabled) | Folder | Określa, czy Folder wymaga klucza zasobu, aby uzyskać dostęp, gdy jest
udostępnione za pomocą linku. |
setShareableByEditors(shareable) | Folder | Określa, czy użytkownicy z uprawnieniami do edycji w elemencie Folder mogą udostępniać treści
innym użytkownikom lub zmienić uprawnienia. |
setSharing(accessType, permissionType) | Folder | Określa, które klasy użytkowników mają dostęp do elementu Folder i jakie uprawnienia
użytkownicy, którym przyznano dostęp wprost. |
setStarred(starred) | Folder | Określa, czy element Folder jest oznaczony gwiazdką na Dysku użytkownika. |
setTrashed(trashed) | Folder | Określa, czy Folder znajduje się w koszu Dysku użytkownika. |
FolderIterator
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getContinuationToken() | String | Pobiera token, którego można użyć do wznowienia tej iteracji w późniejszym czasie. |
hasNext() | Boolean | Określa, czy wywołanie funkcji next() zwróci produkt. |
next() | Folder | Pobiera następny element w kolekcji plików lub folderów. |
Permission
Właściwości
Właściwość | Typ | Opis |
---|---|---|
VIEW | Enum | Użytkownicy, którzy mają dostęp do pliku lub folderu, mogą go tylko wyświetlać i kopiować. |
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ą go tylko wyświetlać, kopiować i komentować. |
OWNER | Enum | Użytkownik jest właścicielem pliku lub folderu. |
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ć, przenosić do kosza i przenosić treści w obrębie dysku współdzielonego. |
NONE | Enum | Użytkownik nie ma żadnych uprawnień do 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. |