Drive Service

Dysk

Ta usługa umożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików oraz folderów na Dysku Google.

Jeśli 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łącz interfejs Drive API

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

NazwaKrótki opis
AccessWyliczenie reprezentujące klasy użytkowników, którzy mają dostęp do pliku lub folderu, oprócz wszystkich użytkowników, którym przyznano dostęp wprost.
DriveAppUmożliwia skryptom tworzenie, znajdowanie oraz modyfikowanie plików i folderów na Dysku Google.
FilePlik na Dysku Google.
FileIteratorIterator, który umożliwia skryptom powtarzanie potencjalnie dużej kolekcji plików.
FolderFolder na Dysku Google.
FolderIteratorObiekt, który umożliwia skryptom powtarzanie tych samych zadań na 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 jawnie przyznano dostęp.
UserKonto użytkownika powiązane 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ą to znaleźć i uzyskać do nich 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
AccessAccessWyliczenie reprezentujące klasy użytkowników, którzy mają dostęp do pliku lub folderu, oprócz wszystkich użytkowników, którym przyznano dostęp wprost.
PermissionPermissionWyliczenie reprezentujące uprawnienia przyznane użytkownikom, którzy mają dostęp do pliku lub folderu, oprócz użytkowników, którym jawnie 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 iteratora.
createFile(blob)FileTworzy plik w katalogu głównym Dysku użytkownika na podstawie Blob dowolnych danych.
createFile(name, content)FileTworzy w katalogu głównym Dysku użytkownika plik tekstowy o podanej nazwie i treści.
createFile(name, content, mimeType)FileW katalogu głównym Dysku użytkownika tworzy plik o podanej nazwie, treści i typie MIME.
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, a następnie go zwraca.
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 wymuszanie zachowania SingleParent w przypadku wszystkich wywołań mających wpływ na elementy nadrzędne elementów.
getFileById(id)FilePobiera plik o podanym identyfikatorze.
getFileByIdAndResourceKey(id, resourceKey)FilePobiera plik o podanym identyfikatorze i kluczu zasobu.
getFiles()FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika.
getFilesByName(name)FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika o podanej nazwie.
getFilesByType(mimeType)FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika, które mają określony typ MIME.
getFolderById(id)FolderPobiera folder o podanym identyfikatorze.
getFolderByIdAndResourceKey(id, resourceKey)FolderPobiera folder o podanym identyfikatorze i kluczu zasobu.
getFolders()FolderIteratorPobiera zbiór wszystkich folderów na Dysku użytkownika.
getFoldersByName(name)FolderIteratorPobiera zbiór wszystkich folderów na Dysku użytkownika o podanej nazwie.
getRootFolder()FolderPobiera folder na poziomie głównym Dysku użytkownika.
getStorageLimit()IntegerPobiera liczbę bajtów, które użytkownik może zapisać na Dysku.
getStorageUsed()IntegerPobiera liczbę bajtów, które użytkownik obecnie przechowuje na Dysku.
getTrashedFiles()FileIteratorPobiera zbiór wszystkich plików znajdujących się w koszu na Dysku użytkownika.
getTrashedFolders()FolderIteratorPobiera zbiór wszystkich folderów z kosza na Dysku użytkownika.
searchFiles(params)FileIteratorPobiera zbiór wszystkich plików na Dysku użytkownika, które spełniają określone kryteria wyszukiwania.
searchFolders(params)FolderIteratorPobiera zbiór wszystkich folderów na Dysku użytkownika, które spełniają określone kryteria wyszukiwania.

File

Metody

MetodaZwracany typKrótki opis
addCommenter(emailAddress)FileDodaj danego użytkownika do listy komentujących: File.
addCommenter(user)FileDodaj danego użytkownika do listy komentujących: File.
addCommenters(emailAddresses)FileDodaj podaną tablicę użytkowników do listy komentujących w elemencie File.
addEditor(emailAddress)FileDodaje wskazanego użytkownika do listy edytorów w File.
addEditor(user)FileDodaje wskazanego użytkownika do listy edytorów w File.
addEditors(emailAddresses)FileDodaje podaną tablicę użytkowników do listy edytorów elementu File.
addViewer(emailAddress)FileDodaje danego użytkownika do listy przeglądających stronę File.
addViewer(user)FileDodaje danego użytkownika do listy przeglądających stronę File.
addViewers(emailAddresses)FileDodaje podaną tablicę użytkowników do listy osób przeglądających element File.
getAccess(email)PermissionPobiera uprawnienia przyznane danemu użytkownikowi.
getAccess(user)PermissionPobiera uprawnienia przyznane danemu użytkownikowi.
getAs(contentType)BlobZwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści.
getBlob()BlobZwracaj dane wewnątrz tego obiektu jako obiekt blob.
getDateCreated()DatePobiera datę utworzenia File.
getDescription()StringPobiera opis obiektu File.
getDownloadUrl()StringPobiera adres URL, którego można użyć do pobrania pliku.
getEditors()User[]Pobiera listę edytorów tego elementu (File).
getId()StringPobiera identyfikator elementu File.
getLastUpdated()DatePobiera datę ostatniej aktualizacji elementu File.
getMimeType()StringPobiera typ MIME pliku.
getName()StringPobiera nazwę elementu File.
getOwner()UserPobiera właściciela pliku.
getParents()FolderIteratorPobiera zbiór 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 przy użyciu linku.
getSecurityUpdateEligible()BooleanSprawdza, czy File może zastosować aktualizację zabezpieczeń, która wymaga dostępu przy użyciu klucza zasobu, gdy jest on udostępniany przy użyciu linku.
getSecurityUpdateEnabled()BooleanSprawdza, czy File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępniany przy użyciu linku.
getSharingAccess()AccessOkreśla, która klasa użytkowników (oprócz poszczególnych użytkowników, którym przyznano dostęp) ma dostęp do File.
getSharingPermission()PermissionOtrzymuje uprawnienia przyznane tym użytkownikom, którzy mają dostęp do elementu File, oprócz wszystkich użytkowników, którym przyznano dostęp wprost.
getSize()IntegerPobiera liczbę bajtów używanych do przechowywania elementu File na Dysku.
getTargetId()StringJeśli to skrót, zwraca identyfikator elementu, do którego wskazuje element.
getTargetMimeType()StringJeśli jest to skrót, zwraca typ MIME elementu, który wskazuje.
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()StringPobiera adres URL, za pomocą którego można otworzyć plik File w aplikacji Google, takiej jak Dysk czy Dokumenty.
getViewers()User[]Pobiera listę przeglądających i komentujących tego elementu (File).
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji elementu File mogą udostępniać pliki innym użytkownikom czy zmieniać uprawnienia.
isStarred()BooleanOkreśla, czy zasób File jest oznaczony gwiazdką na Dysku użytkownika.
isTrashed()BooleanOkreśla, czy zasób 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ę.
makeCopy(name, destination)FileW katalogu docelowym utworzy kopię pliku i nada mu nazwę.
moveTo(destination)FilePrzenosi ten element do podanego folderu docelowego.
removeCommenter(emailAddress)FileUsuwa danego użytkownika z listy komentujących elementu File.
removeCommenter(user)FileUsuwa danego użytkownika z listy komentujących elementu File.
removeEditor(emailAddress)FileUsuwa danego użytkownika z listy edytorów File.
removeEditor(user)FileUsuwa danego użytkownika z listy edytorów File.
removeViewer(emailAddress)FileUsuwa danego użytkownika z listy przeglądających i komentujących elementu File.
removeViewer(user)FileUsuwa danego użytkownika z listy przeglądających i komentujących elementu File.
revokePermissions(emailAddress)FileUnieważnia dostęp do uprawnienia File przyznanego danemu użytkownikowi.
revokePermissions(user)FileUnieważnia dostęp do uprawnienia File przyznanego danemu użytkownikowi.
setContent(content)FileZastępuje treść pliku danym zamiennikiem.
setDescription(description)FileUstawia opis obiektu File.
setName(name)FileUstawia nazwę: File.
setOwner(emailAddress)FileZmienia właściciela elementu File.
setOwner(user)FileZmienia właściciela elementu File.
setSecurityUpdateEnabled(enabled)FileOkreśla, czy File wymaga klucza zasobu w celu uzyskania dostępu, gdy jest udostępniany za pomocą linku.
setShareableByEditors(shareable)FileOkreśla, czy użytkownicy z uprawnieniami do edycji elementu File mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia.
setSharing(accessType, permissionType)FileOkreśla, która klasa użytkowników ma dostęp do elementu File i jakie uprawnienia są im przyznane (z wyjątkiem poszczególnych użytkowników, którym przyznano dostęp bezpośrednio).
setStarred(starred)FileOkreśla, czy File ma być oznaczony gwiazdką na Dysku użytkownika.
setTrashed(trashed)FileOkreśla, czy zasób 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 metody next() spowoduje zwrócenie elementu.
next()FilePobiera następny element w kolekcji plików lub folderów.

Folder

Metody

MetodaZwracany typKrótki opis
addEditor(emailAddress)FolderDodaje wskazanego użytkownika do listy edytorów w Folder.
addEditor(user)FolderDodaje wskazanego użytkownika do listy edytorów w Folder.
addEditors(emailAddresses)FolderDodaje podaną tablicę użytkowników do listy edytorów elementu Folder.
addViewer(emailAddress)FolderDodaje danego użytkownika do listy przeglądających stronę Folder.
addViewer(user)FolderDodaje danego użytkownika do listy przeglądających stronę Folder.
addViewers(emailAddresses)FolderDodaje podaną tablicę użytkowników do listy osób przeglądających element Folder.
createFile(blob)FileTworzy plik w bieżącym folderze na podstawie dowolnych 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, a następnie go zwraca.
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 danemu użytkownikowi.
getAccess(user)PermissionPobiera uprawnienia przyznane danemu użytkownikowi.
getDateCreated()DatePobiera datę utworzenia Folder.
getDescription()StringPobiera opis obiektu Folder.
getEditors()User[]Pobiera listę edytorów tego elementu (Folder).
getFiles()FileIteratorPobiera zbiór wszystkich plików podrzędnych bieżącego folderu.
getFilesByName(name)FileIteratorPobiera zbiór wszystkich plików, które są podrzędne wobec bieżącego folderu i mają podaną nazwę.
getFilesByType(mimeType)FileIteratorPobiera zbiór wszystkich plików podrzędnych bieżącego folderu i mających podany typ MIME.
getFolders()FolderIteratorPobiera zbiór wszystkich folderów podrzędnych wobec bieżącego folderu.
getFoldersByName(name)FolderIteratorPobiera zbiór wszystkich folderów, które są podrzędne wobec bieżącego folderu i mają podaną nazwę.
getId()StringPobiera identyfikator elementu Folder.
getLastUpdated()DatePobiera datę ostatniej aktualizacji elementu Folder.
getName()StringPobiera nazwę elementu Folder.
getOwner()UserPrzejmuje właściciela elementu Folder.
getParents()FolderIteratorPobiera zbiór 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 przy użyciu linku.
getSecurityUpdateEligible()BooleanSprawdza, czy Folder może zastosować aktualizację zabezpieczeń, która wymaga dostępu przy użyciu klucza zasobu, gdy jest on udostępniany przy użyciu linku.
getSecurityUpdateEnabled()BooleanSprawdza, czy Folder wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępniany przy użyciu linku.
getSharingAccess()AccessOkreśla, która klasa użytkowników (oprócz poszczególnych użytkowników, którym przyznano dostęp) ma dostęp do Folder.
getSharingPermission()PermissionOtrzymuje uprawnienia przyznane tym użytkownikom, którzy mają dostęp do elementu Folder, oprócz wszystkich użytkowników, którym przyznano dostęp wprost.
getSize()IntegerPobiera liczbę bajtów używanych do przechowywania elementu Folder na Dysku.
getUrl()StringPobiera adres URL, za pomocą którego można otworzyć plik Folder w aplikacji Google, takiej jak Dysk czy Dokumenty.
getViewers()User[]Pobiera listę przeglądających i komentujących tego elementu (Folder).
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji elementu Folder mogą udostępniać pliki innym użytkownikom czy zmieniać uprawnienia.
isStarred()BooleanOkreśla, czy zasób Folder jest oznaczony gwiazdką na Dysku użytkownika.
isTrashed()BooleanOkreśla, czy zasób 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 Folder.
removeEditor(user)FolderUsuwa danego użytkownika z listy edytorów Folder.
removeViewer(emailAddress)FolderUsuwa danego użytkownika z listy przeglądających i komentujących elementu Folder.
removeViewer(user)FolderUsuwa danego użytkownika z listy przeglądających i komentujących elementu Folder.
revokePermissions(emailAddress)FolderUnieważnia dostęp do uprawnienia Folder przyznanego danemu użytkownikowi.
revokePermissions(user)FolderUnieważnia dostęp do uprawnienia Folder przyznanego danemu użytkownikowi.
searchFiles(params)FileIteratorPobiera zbiór wszystkich plików podrzędnych bieżącego folderu i pasujących do podanych kryteriów wyszukiwania.
searchFolders(params)FolderIteratorPobiera zbiór wszystkich folderów, które są podrzędne wobec bieżącego folderu i spełniają określone kryteria wyszukiwania.
setDescription(description)FolderUstawia opis obiektu Folder.
setName(name)FolderUstawia nazwę: Folder.
setOwner(emailAddress)FolderZmienia właściciela elementu Folder.
setOwner(user)FolderZmienia właściciela elementu Folder.
setSecurityUpdateEnabled(enabled)FolderOkreśla, czy Folder wymaga klucza zasobu w celu uzyskania dostępu, gdy jest udostępniany za pomocą linku.
setShareableByEditors(shareable)FolderOkreśla, czy użytkownicy z uprawnieniami do edycji elementu Folder mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia.
setSharing(accessType, permissionType)FolderOkreśla, która klasa użytkowników ma dostęp do elementu Folder i jakie uprawnienia są im przyznane (z wyjątkiem poszczególnych użytkowników, którym przyznano dostęp bezpośrednio).
setStarred(starred)FolderOkreśla, czy Folder ma być oznaczony gwiazdką na Dysku użytkownika.
setTrashed(trashed)FolderOkreśla, czy zasób 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 metody next() spowoduje zwrócenie elementu.
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 na dysku współdzielonym.
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.