Drive Service

Dysk

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

NazwaKrótki opis
AccessEnum 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.
DriveAppZezwala skryptom na tworzenie, znajdowanie i modyfikowanie plików oraz folderów na Dysku Google.
Fileplik na Dysku Google,
FileIteratorIterator, który umożliwia skryptom iterację na potencjalnie dużym zbiorze plików.
FolderFolder na Dysku Google.
FolderIteratorObiekt, który umożliwia skryptom iterację na potencjalnie dużej kolekcji folderów.
PermissionEnum reprezentujące uprawnienia przyznane użytkownikom, którzy mają dostęp do pliku lub folderu: wszystkim użytkownikom, którym wprost przyznano dostęp.
UserUżytkownik powiązany z plikiem na Dysku Google.

Access

Właściwości

WłaściwośćTypOpis
ANYONEEnumKażdy użytkownik internetu może znajdować i uzyskiwać dostęp.
ANYONE_WITH_LINKEnumKażdy użytkownik mający link może uzyskać dostęp.
DOMAINEnumOsoby w Twojej domenie mogą znajdować i uzyskiwać dostęp.
DOMAIN_WITH_LINKEnumOsoby w Twojej domenie mające link mogą uzyskiwać dostęp.
PRIVATEEnumDostęp mogą uzyskać tylko osoby z uprawnieniami przyznanymi wprost.

DriveApp

Właściwości

WłaściwośćTypOpis
AccessAccessEnum 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.
PermissionPermissionEnum 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

MetodaZwracany typKrótki opis
continueFileIterator(continuationToken)FileIteratorWznawia iterację pliku przy użyciu tokena kontynuacji z poprzedniego iteratora.
continueFolderIterator(continuationToken)FolderIteratorWznawia iterację folderu przy użyciu tokena kontynuacji z poprzedniego iteracji.
createFile(blob)FileTworzy plik w katalogu głównym Dysku użytkownika na podstawie wybranych danych (Blob)
createFile(name, content)FileTworzy plik tekstowy o podanej nazwie i zawartości w katalogu głównym Dysku użytkownika.
createFile(name, content, mimeType)FileTworzy plik o podanej nazwie, zawartości i typie MIME w katalogu głównym Dysku użytkownika.
createFolder(name)FolderTworzy folder o podanej nazwie w katalogu głównym Dysku użytkownika.
createShortcut(targetId)FileTworzy skrót do podanego identyfikatora elementu na Dysku i zwraca ten identyfikator.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTworzy skrót do podanego identyfikatora elementu na Dysku i klucza zasobu i zwraca ten skrót.
enforceSingleParent(value)voidWłącza lub wyłącza zachowanie forceSingleParent w przypadku wszystkich wywołań mających wpływ na elementy nadrzędne.
getFileById(id)FilePobiera plik o podanym identyfikatorze.
getFileByIdAndResourceKey(id, resourceKey)FilePobiera plik o podanym identyfikatorze i kluczu zasobu.
getFiles()FileIteratorPobiera kolekcję wszystkich plików na Dysku użytkownika.
getFilesByName(name)FileIteratorPobiera kolekcję wszystkich plików na Dysku użytkownika o podanej nazwie.
getFilesByType(mimeType)FileIteratorPobiera kolekcję wszystkich plików z Dysku użytkownika o podanym typie 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 podanej nazwie.
getRootFolder()FolderPobiera folder znajdujący się 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, które użytkownik obecnie przechowuje na Dysku.
getTrashedFiles()FileIteratorPobiera kolekcję wszystkich plików w koszu Dysku użytkownika.
getTrashedFolders()FolderIteratorPobiera kolekcję wszystkich folderów w koszu Dysku użytkownika.
searchFiles(params)FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika, które pasują do zapytania kryteria.
searchFolders(params)FolderIteratorPobiera zbiór wszystkich folderów na Dysku użytkownika, które pasują do zapytania kryteria.

File

Metody

MetodaZwracany typKrótki opis
addCommenter(emailAddress)FileDodaj danego użytkownika do listy komentujących zasobu File.
addCommenter(user)FileDodaj danego użytkownika do listy komentujących zasobu File.
addCommenters(emailAddresses)FileDodaj podaną tablicę użytkowników do listy komentujących obiektu File.
addEditor(emailAddress)FileDodaje danego użytkownika do listy edytorów zasobu File.
addEditor(user)FileDodaje danego użytkownika do listy edytorów zasobu File.
addEditors(emailAddresses)FileDodaje podaną tablicę użytkowników do listy edytorów zasobu File.
addViewer(emailAddress)FileDodaje danego użytkownika do listy przeglądających w: File.
addViewer(user)FileDodaje danego użytkownika do listy przeglądających w: File.
addViewers(emailAddresses)FileDodaje podaną tablicę użytkowników do listy przeglądających obiekt File.
getAccess(email)PermissionPobiera uprawnienie przyznane danemu użytkownikowi.
getAccess(user)PermissionPobiera uprawnienie przyznane danemu użytkownikowi.
getAs(contentType)BlobZwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści.
getBlob()BlobZwraca dane wewnątrz tego obiektu jako obiekt blob.
getDateCreated()DateOtrzymuje datę utworzenia elementu File.
getDescription()StringPobiera opis elementu File.
getDownloadUrl()StringPobiera adres URL, którego można użyć do pobrania pliku.
getEditors()User[]Pobiera listę edytorów elementu File.
getId()StringPobiera identyfikator elementu File.
getLastUpdated()DatePobiera datę ostatniej aktualizacji urządzenia File.
getMimeType()StringPobiera typ MIME pliku.
getName()StringPobiera nazwę elementu File.
getOwner()UserPobiera właściciela pliku.
getParents()FolderIteratorPobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnymi folderu File.
getResourceKey()StringPobiera klucz zasobu File wymagany, aby uzyskać dostęp do elementów, które zostały udostępnione za pomocą linku.
getSecurityUpdateEligible()BooleanOkreś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()BooleanOkreśla, czy File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępnione za pomocą linku.
getSharingAccess()AccessPobiera 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()Permissionpobiera 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()IntegerPobiera liczbę bajtów używanych do przechowywania elementu File na Dysku.
getTargetId()StringJeśli jest to skrót, zwraca identyfikator elementu, do którego prowadzi.
getTargetMimeType()StringJeśli jest to skrót, zwraca typ MIME elementu, do którego prowadzi.
getTargetResourceKey()StringJeśli plik jest skrótem, zwraca klucz zasobu elementu, do którego prowadzi.
getThumbnail()BlobPobiera obraz miniatury pliku lub null, jeśli miniatura nie istnieje.
getUrl()StringUzyskuje 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()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji zasobu File mogą udostępnić innym użytkownikom lub zmienić uprawnienia.
isStarred()BooleanOkreśla, czy element File został oznaczony gwiazdką na Dysku użytkownika.
isTrashed()BooleanOkreśla, czy File znajduje się w koszu na Dysku użytkownika.
makeCopy()FileTworzy kopię pliku.
makeCopy(destination)FileTworzy kopię pliku w katalogu docelowym.
makeCopy(name)FileTworzy kopię pliku i nadaje mu nazwę (nadać mu podaną nazwę).
makeCopy(name, destination)FileTworzy kopię pliku w katalogu docelowym i nadaje mu nazwę na podstawie podanej nazwy.
moveTo(destination)FilePrzenosi ten element do podanego folderu docelowego.
removeCommenter(emailAddress)FileUsuwa dane użytkownika z listy komentujących do: File.
removeCommenter(user)FileUsuwa dane użytkownika z listy komentujących do: File.
removeEditor(emailAddress)FileUsuwa danego użytkownika z listy edytorów zasobu File.
removeEditor(user)FileUsuwa danego użytkownika z listy edytorów zasobu File.
removeViewer(emailAddress)FileUsuwa dane użytkownika z listy przeglądających i komentujących File.
removeViewer(user)FileUsuwa dane użytkownika z listy przeglądających i komentujących File.
revokePermissions(emailAddress)FileOdbierze uprawnienia File przyznane danemu użytkownikowi.
revokePermissions(user)FileOdbierze uprawnienia File przyznane danemu użytkownikowi.
setContent(content)FilePowoduje zastąpienie zawartości pliku danym zamiennikiem.
setDescription(description)FileUstawia opis elementu File.
setName(name)FileOkreśla nazwę elementu File.
setOwner(emailAddress)FileZmienia właściciela: File.
setOwner(user)FileZmienia właściciela: File.
setSecurityUpdateEnabled(enabled)FileOkreśla, czy File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępnione za pomocą linku.
setShareableByEditors(shareable)FileOkreś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)FileOkreś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)FileOkreśla, czy element File jest oznaczony gwiazdką na Dysku użytkownika.
setTrashed(trashed)FileOkreśla, czy File znajduje się w koszu Dysku użytkownika.

FileIterator

Metody

MetodaZwracany typKrótki opis
getContinuationToken()StringPobiera token, którego można użyć do wznowienia tej iteracji w późniejszym czasie.
hasNext()BooleanOkreśla, czy wywołanie funkcji next() zwróci produkt.
next()FilePobiera następny element w kolekcji plików lub folderów.

Folder

Metody

MetodaZwracany typKrótki opis
addEditor(emailAddress)FolderDodaje danego użytkownika do listy edytorów zasobu Folder.
addEditor(user)FolderDodaje danego użytkownika do listy edytorów zasobu Folder.
addEditors(emailAddresses)FolderDodaje podaną tablicę użytkowników do listy edytorów zasobu Folder.
addViewer(emailAddress)FolderDodaje danego użytkownika do listy przeglądających w: Folder.
addViewer(user)FolderDodaje danego użytkownika do listy przeglądających w: Folder.
addViewers(emailAddresses)FolderDodaje podaną tablicę użytkowników do listy przeglądających obiekt Folder.
createFile(blob)FileTworzy plik w bieżącym folderze na podstawie wybranych danych (Blob).
createFile(name, content)FileTworzy w bieżącym folderze plik tekstowy o podanej nazwie i zawartości.
createFile(name, content, mimeType)FileTworzy w bieżącym folderze plik o podanej nazwie, zawartości i typie MIME.
createFolder(name)FolderTworzy folder o podanej nazwie w bieżącym folderze.
createShortcut(targetId)FileTworzy skrót do podanego identyfikatora elementu na Dysku i zwraca ten identyfikator.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTworzy skrót do podanego identyfikatora elementu na Dysku i klucza zasobu i zwraca ten skrót.
getAccess(email)PermissionPobiera uprawnienie przyznane danemu użytkownikowi.
getAccess(user)PermissionPobiera uprawnienie przyznane danemu użytkownikowi.
getDateCreated()DateOtrzymuje datę utworzenia elementu Folder.
getDescription()StringPobiera opis elementu Folder.
getEditors()User[]Pobiera listę edytorów elementu Folder.
getFiles()FileIteratorPobiera kolekcję wszystkich plików podrzędnych względem bieżącego folderu.
getFilesByName(name)FileIteratorPobiera kolekcję wszystkich plików, które są podrzędne względem bieżącego folderu i mają podaną nazwę.
getFilesByType(mimeType)FileIteratorPobiera kolekcję wszystkich plików podrzędnych względem bieżącego folderu i o podanym typie MIME.
getFolders()FolderIteratorPobiera kolekcję wszystkich folderów podrzędnych folderu bieżącego.
getFoldersByName(name)FolderIteratorPobiera kolekcję wszystkich folderów, które są folderami podrzędnymi bieżącego folderu i mają podaną nazwę.
getId()StringPobiera identyfikator elementu Folder.
getLastUpdated()DatePobiera datę ostatniej aktualizacji urządzenia Folder.
getName()StringPobiera nazwę elementu Folder.
getOwner()UserPobiera właściciela tego elementu (Folder).
getParents()FolderIteratorPobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnymi folderu Folder.
getResourceKey()StringPobiera klucz zasobu Folder wymagany, aby uzyskać dostęp do elementów, które zostały udostępnione za pomocą linku.
getSecurityUpdateEligible()BooleanOkreś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()BooleanOkreśla, czy Folder wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępnione za pomocą linku.
getSharingAccess()AccessPobiera 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()Permissionpobiera 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()IntegerPobiera liczbę bajtów używanych do przechowywania elementu Folder na Dysku.
getUrl()StringUzyskuje 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()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji zasobu Folder mogą udostępnić innym użytkownikom lub zmienić uprawnienia.
isStarred()BooleanOkreśla, czy element Folder został oznaczony gwiazdką na Dysku użytkownika.
isTrashed()BooleanOkreśla, czy Folder znajduje się w koszu na Dysku użytkownika.
moveTo(destination)FolderPrzenosi ten element do podanego folderu docelowego.
removeEditor(emailAddress)FolderUsuwa danego użytkownika z listy edytorów zasobu Folder.
removeEditor(user)FolderUsuwa danego użytkownika z listy edytorów zasobu Folder.
removeViewer(emailAddress)FolderUsuwa dane użytkownika z listy przeglądających i komentujących Folder.
removeViewer(user)FolderUsuwa dane użytkownika z listy przeglądających i komentujących Folder.
revokePermissions(emailAddress)FolderOdbierze uprawnienia Folder przyznane danemu użytkownikowi.
revokePermissions(user)FolderOdbierze uprawnienia Folder przyznane danemu użytkownikowi.
searchFiles(params)FileIteratorPobiera zbiór wszystkich plików podrzędnych względem bieżącego folderu i które pasują do danego wyszukiwania kryteria.
searchFolders(params)FolderIteratorPobiera zbiór wszystkich folderów podrzędnych bieżącego folderu i pasujących do podanego wyszukiwania kryteria.
setDescription(description)FolderUstawia opis elementu Folder.
setName(name)FolderOkreśla nazwę elementu Folder.
setOwner(emailAddress)FolderZmienia właściciela: Folder.
setOwner(user)FolderZmienia właściciela: Folder.
setSecurityUpdateEnabled(enabled)FolderOkreśla, czy Folder wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępnione za pomocą linku.
setShareableByEditors(shareable)FolderOkreś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)FolderOkreś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)FolderOkreśla, czy element Folder jest oznaczony gwiazdką na Dysku użytkownika.
setTrashed(trashed)FolderOkreśla, czy Folder znajduje się w koszu Dysku użytkownika.

FolderIterator

Metody

MetodaZwracany typKrótki opis
getContinuationToken()StringPobiera token, którego można użyć do wznowienia tej iteracji w późniejszym czasie.
hasNext()BooleanOkreśla, czy wywołanie funkcji next() zwróci produkt.
next()FolderPobiera następny element w kolekcji plików lub folderów.

Permission

Właściwości

WłaściwośćTypOpis
VIEWEnumUżytkownicy, którzy mają dostęp do pliku lub folderu, mogą go tylko wyświetlać i kopiować.
EDITEnumUżytkownicy, którzy mają dostęp do pliku lub folderu, mogą go edytować.
COMMENTEnumUżytkownicy, którzy mają dostęp do pliku lub folderu, mogą go tylko wyświetlać, kopiować i komentować.
OWNEREnumUżytkownik jest właścicielem pliku lub folderu.
ORGANIZEREnumUżytkownicy, którzy mogą porządkować pliki i foldery na dysku współdzielonym.
FILE_ORGANIZEREnumUżytkownicy, którzy mogą edytować, przenosić do kosza i przenosić treści w obrębie dysku współdzielonego.
NONEEnumUżytkownik nie ma żadnych uprawnień do pliku lub folderu.

User

Metody

MetodaZwracany typKrótki opis
getDomain()StringPobiera nazwę domeny powiązaną z kontem użytkownika.
getEmail()StringPobiera adres e-mail użytkownika.
getName()StringPobiera nazwę użytkownika.
getPhotoUrl()StringPobiera adres URL zdjęcia użytkownika.