Drive Service

Dysk

Ta usługa umożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików oraz folderów na Dysku Google. Wbudowana usługa Dysku jest łatwiejsza w użyciu, ale ma pewne ograniczenia. Aby korzystać z najnowszych funkcji i pomocy oraz uzyskiwać dostęp do plików i folderów na dyskach współdzielonych, używaj zaawansowanej usługi Dysku.

Jeśli skrypt korzysta ze standardowego projektu Cloud zamiast domyślnego projektu Cloud, musisz ręcznie włączyć interfejs Drive API. Włącz interfejs Drive API w standardowym projekcie Cloud:

Włącz interfejs Drive API

Poniższy przykładowy kod pokazuje, jak rejestrować nazwy każdego pliku 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

NazwaKrótki opis
AccessWyliczenie reprezentujące klasy użytkowników, którzy mogą uzyskać dostęp do pliku lub folderu, oprócz poszczególnych użytkowników, którym wyraźnie przyznano dostęp.
DriveAppUmożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików oraz folderów na Dysku Google.
Fileplik na Dysku Google,
FileIteratorIterator, który umożliwia skryptom iterowanie po potencjalnie dużym zbiorze plików.
Folderfolder na Dysku Google;
FolderIteratorObiekt, który umożliwia skryptom iterowanie po potencjalnie dużej kolekcji folderów.
PermissionWyliczenie reprezentujące uprawnienia przyznane użytkownikom, którzy mają dostęp do pliku lub folderu, oprócz użytkowników, którym wyraźnie 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żda osoba mająca link może uzyskać dostęp do tego elementu.
DOMAINEnumOsoby w Twojej domenie mogą znajdować i uzyskiwać dostęp.
DOMAIN_WITH_LINKEnumOsoby w domenie, które mają link, mogą uzyskiwać dostęp.
PRIVATEEnumDostęp mogą uzyskać tylko osoby z uprawnieniami przyznanymi wprost.

DriveApp

Właściwości

WłaściwośćTypOpis
AccessAccessWyliczenie reprezentujące klasy użytkowników, którzy mogą uzyskać dostęp do pliku lub folderu, oprócz poszczególnych użytkowników, którym wyraźnie przyznano dostęp.
PermissionPermissionWyliczenie reprezentujące uprawnienia przyznane użytkownikom, którzy mają dostęp do pliku lub folderu, oprócz użytkowników, którym wyraźnie 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, używając tokena kontynuacji z poprzedniego iteratora.
createFile(blob)FileTworzy plik w folderze głównym na Dysku użytkownika na podstawie podanego Blob z dowolnymi danymi.
createFile(name, content)FileTworzy plik tekstowy w katalogu głównym Dysku użytkownika o podanej nazwie i zawartoś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 na Dysku użytkownika o podanej nazwie.
createShortcut(targetId)FileTworzy skrót do podanego identyfikatora elementu na Dysku i zwraca go.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTworzy skrót do podanego identyfikatora elementu na Dysku i klucza zasobu, a następnie go zwraca.
enforceSingleParent(value)voidWłącza lub wyłącza zachowanie enforceSingleParent w przypadku wszystkich wywołań wpływających 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, które mają podaną nazwę.
getFilesByType(mimeType)FileIteratorPobiera kolekcję wszystkich plików na Dysku użytkownika, które mają podany typ 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, które mają podaną nazwę.
getRootFolder()FolderPobiera folder 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 na Dysku użytkownika.
getTrashedFolders()FolderIteratorPobiera kolekcję wszystkich folderów w koszu na Dysku użytkownika.
searchFiles(params)FileIteratorPobiera kolekcję wszystkich plików na Dysku użytkownika, które pasują do podanych kryteriów wyszukiwania.
searchFolders(params)FolderIteratorPobiera kolekcję wszystkich folderów na Dysku użytkownika, które spełniają podane kryteria wyszukiwania.

File

Metody

MetodaZwracany typKrótki opis
addCommenter(emailAddress)FileDodaj podanego użytkownika do listy komentujących File.
addCommenter(user)FileDodaj podanego użytkownika do listy komentujących File.
addCommenters(emailAddresses)FileDodaj podaną tablicę użytkowników do listy komentujących w przypadku elementu File.
addEditor(emailAddress)FileDodaje podanego użytkownika do listy edytujących File.
addEditor(user)FileDodaje podanego użytkownika do listy edytujących File.
addEditors(emailAddresses)FileDodaje podaną tablicę użytkowników do listy edytujących File.
addViewer(emailAddress)FileDodaje podanego użytkownika do listy osób, które mogą wyświetlać File.
addViewer(user)FileDodaje podanego użytkownika do listy osób, które mogą wyświetlać File.
addViewers(emailAddresses)FileDodaje podaną tablicę użytkowników do listy widzów File.
getAccess(email)PermissionPobiera uprawnienia przyznane konkretnemu użytkownikowi.
getAccess(user)PermissionPobiera uprawnienia przyznane konkretnemu użytkownikowi.
getAs(contentType)BlobZwraca dane w tym obiekcie jako obiekt blob przekonwertowany na określony typ treści.
getBlob()BlobZwraca dane w tym obiekcie jako obiekt blob.
getDateCreated()DatePobiera datę utworzenia File.
getDescription()StringPobiera opis elementu File.
getDownloadUrl()StringPobiera adres URL, który można wykorzystać do pobrania pliku.
getEditors()User[]Pobiera listę edytorów tego File.
getId()StringPobiera identyfikator File.
getLastUpdated()DatePobiera datę ostatniej aktualizacji File.
getMimeType()StringPobiera typ MIME pliku.
getName()StringPobiera nazwę File.
getOwner()UserPobiera właściciela pliku.
getParents()FolderIteratorPobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnymi elementu File.
getResourceKey()StringPobiera klucz zasobu File, który jest wymagany do uzyskania dostępu do elementów udostępnionych za pomocą linku.
getSecurityUpdateEligible()BooleanOkreśla, czy ten File może zastosować aktualizację zabezpieczeń, która wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniany za pomocą linku.
getSecurityUpdateEnabled()BooleanOkreśla, czy ten File wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniany za pomocą linku.
getSharingAccess()AccessOkreśla, która grupa użytkowników może uzyskać dostęp do File, oprócz użytkowników, którym wyraźnie przyznano dostęp.
getSharingPermission()PermissionPobiera uprawnienia przyznane użytkownikom, którzy mają dostęp do File, oprócz użytkowników, którym wyraźnie przyznano dostęp.
getSize()IntegerPobiera liczbę bajtów używanych do przechowywania 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()Blob|nullPobiera miniaturę pliku lub null, jeśli miniatura nie istnieje.
getUrl()StringPobiera adres URL, którego można użyć do otwarcia File w aplikacji Google, takiej jak Dysk lub Dokumenty.
getViewers()User[]Pobiera listę przeglądających i komentujących dla tego File.
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji File mogą udostępniać je innym użytkownikom lub zmieniać uprawnienia.
isStarred()BooleanOkreśla, czy 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 jej podaną nazwę.
makeCopy(name, destination)FileTworzy kopię pliku w katalogu docelowym i nadaje jej podaną nazwę.
moveTo(destination)FilePrzenosi ten element do podanego folderu docelowego.
removeCommenter(emailAddress)FileUsuwa danego użytkownika z listy komentujących File.
removeCommenter(user)FileUsuwa danego użytkownika z listy komentujących File.
removeEditor(emailAddress)FileUsuwa danego użytkownika z listy osób edytujących File.
removeEditor(user)FileUsuwa danego użytkownika z listy osób edytujących File.
removeViewer(emailAddress)FileUsuwa danego użytkownika z listy przeglądających i komentujących File.
removeViewer(user)FileUsuwa danego użytkownika z listy przeglądających i komentujących File.
revokePermissions(emailAddress)FileUnieważnia dostęp do File przyznany danemu użytkownikowi.
revokePermissions(user)FileUnieważnia dostęp do File przyznany danemu użytkownikowi.
setContent(content)FileZastępuje zawartość pliku podanym tekstem.
setDescription(description)FileUstawia opis elementu File.
setName(name)FileUstawia 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 do uzyskania dostępu, gdy jest udostępniany za pomocą linku.
setShareableByEditors(shareable)FileOkreśla, czy użytkownicy z uprawnieniami do edycji File mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia.
setSharing(accessType, permissionType)FileOkreśla, która klasa użytkowników może uzyskać dostęp do File i jakie uprawnienia są im przyznawane, oprócz uprawnień przyznanych poszczególnym użytkownikom.
setStarred(starred)FileOkreśla, czy File jest oznaczony gwiazdką na Dysku użytkownika.
setTrashed(trashed)FileOkreśla, czy File znajduje się w koszu na 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 element.
next()FilePobiera następny element w kolekcji plików lub folderów.

Folder

Metody

MetodaZwracany typKrótki opis
addEditor(emailAddress)FolderDodaje podanego użytkownika do listy edytujących Folder.
addEditor(user)FolderDodaje podanego użytkownika do listy edytujących Folder.
addEditors(emailAddresses)FolderDodaje podaną tablicę użytkowników do listy edytujących Folder.
addViewer(emailAddress)FolderDodaje podanego użytkownika do listy osób, które mogą wyświetlać Folder.
addViewer(user)FolderDodaje podanego użytkownika do listy osób, które mogą wyświetlać Folder.
addViewers(emailAddresses)FolderDodaje podaną tablicę użytkowników do listy widzów Folder.
createFile(blob)FileTworzy w bieżącym folderze plik z podanym Blob dowolnych danych.
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 w bieżącym folderze folder o podanej nazwie.
createShortcut(targetId)FileTworzy skrót do podanego identyfikatora elementu na Dysku i zwraca go.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTworzy skrót do podanego identyfikatora elementu na Dysku i klucza zasobu, a następnie go zwraca.
getAccess(email)PermissionPobiera uprawnienia przyznane konkretnemu użytkownikowi.
getAccess(user)PermissionPobiera uprawnienia przyznane konkretnemu użytkownikowi.
getDateCreated()DatePobiera datę utworzenia Folder.
getDescription()StringPobiera opis elementu Folder.
getEditors()User[]Pobiera listę edytorów tego Folder.
getFiles()FileIteratorPobiera kolekcję wszystkich plików, które są elementami podrzędnymi bieżącego folderu.
getFilesByName(name)FileIteratorPobiera kolekcję wszystkich plików, które są elementami podrzędnymi bieżącego folderu i mają podaną nazwę.
getFilesByType(mimeType)FileIteratorPobiera kolekcję wszystkich plików, które są elementami podrzędnymi bieżącego folderu i mają podany typ MIME.
getFolders()FolderIteratorPobiera kolekcję wszystkich folderów podrzędnych względem bieżącego folderu.
getFoldersByName(name)FolderIteratorPobiera kolekcję wszystkich folderów podrzędnych względem bieżącego folderu, które mają podaną nazwę.
getId()StringPobiera identyfikator Folder.
getLastUpdated()DatePobiera datę ostatniej aktualizacji Folder.
getName()StringPobiera nazwę Folder.
getOwner()UserPobiera właściciela tego zasobu Folder.
getParents()FolderIteratorPobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnymi elementu Folder.
getResourceKey()StringPobiera klucz zasobu Folder, który jest wymagany do uzyskania dostępu do elementów udostępnionych za pomocą linku.
getSecurityUpdateEligible()BooleanOkreśla, czy ten Folder może zastosować aktualizację zabezpieczeń, która wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniany za pomocą linku.
getSecurityUpdateEnabled()BooleanOkreśla, czy ten Folder wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniany za pomocą linku.
getSharingAccess()AccessOkreśla, która grupa użytkowników może uzyskać dostęp do Folder, oprócz użytkowników, którym wyraźnie przyznano dostęp.
getSharingPermission()PermissionPobiera uprawnienia przyznane użytkownikom, którzy mają dostęp do Folder, oprócz użytkowników, którym wyraźnie przyznano dostęp.
getSize()IntegerPobiera liczbę bajtów używanych do przechowywania Folder na Dysku.
getUrl()StringPobiera adres URL, którego można użyć do otwarcia Folder w aplikacji Google, takiej jak Dysk lub Dokumenty.
getViewers()User[]Pobiera listę przeglądających i komentujących dla tego Folder.
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji Folder mogą udostępniać je innym użytkownikom lub zmieniać uprawnienia.
isStarred()BooleanOkreśla, czy 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 osób edytujących Folder.
removeEditor(user)FolderUsuwa danego użytkownika z listy osób edytujących Folder.
removeViewer(emailAddress)FolderUsuwa danego użytkownika z listy przeglądających i komentujących Folder.
removeViewer(user)FolderUsuwa danego użytkownika z listy przeglądających i komentujących Folder.
revokePermissions(emailAddress)FolderUnieważnia dostęp do Folder przyznany danemu użytkownikowi.
revokePermissions(user)FolderUnieważnia dostęp do Folder przyznany danemu użytkownikowi.
searchFiles(params)FileIteratorPobiera kolekcję wszystkich plików, które są elementami podrzędnymi bieżącego folderu i spełniają podane kryteria wyszukiwania.
searchFolders(params)FolderIteratorPobiera kolekcję wszystkich folderów, które są elementami podrzędnymi bieżącego folderu i spełniają podane kryteria wyszukiwania.
setDescription(description)FolderUstawia opis elementu Folder.
setName(name)FolderUstawia 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 do uzyskania dostępu, gdy jest udostępniany za pomocą linku.
setShareableByEditors(shareable)FolderOkreśla, czy użytkownicy z uprawnieniami do edycji Folder mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia.
setSharing(accessType, permissionType)FolderOkreśla, która klasa użytkowników może uzyskać dostęp do Folder i jakie uprawnienia są im przyznawane, oprócz uprawnień przyznanych poszczególnym użytkownikom.
setStarred(starred)FolderOkreśla, czy Folder jest oznaczony gwiazdką na Dysku użytkownika.
setTrashed(trashed)FolderOkreśla, czy Folder znajduje się w koszu na 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 element.
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świetlić lub skopiować.
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ć lub 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 na dysku współdzielonym.
NONEEnumUżytkownik nie ma żadnych uprawnień do pliku lub folderu.

User

Metody

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