Drive Service

Dysk

Ta usługa umożliwia 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 plików w folderze Moje Dysku 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
AccessTyp enum reprezentujący klasy użytkowników, którzy mogą uzyskać dostęp do pliku lub folderu, oprócz poszczególnych użytkowników, którzy uzyskali dostęp.
DriveAppUmożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików oraz folderów na Dysku Google.
Fileplik na Dysku Google,
FileIteratorĆwiczenie, które umożliwia skryptom przeszukiwanie potencjalnie dużej kolekcji plików.
Folderfolder na Dysku Google,
FolderIteratorObiekt, który umożliwia skryptom iterowanie przez potencjalnie dużą kolekcję folderów.
PermissionTyp enumeracji reprezentujący uprawnienia przyznane użytkownikom, którzy mogą uzyskać dostęp do pliku lub folderu, z wyłączeniem poszczególnych użytkowników, którym 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 do tych treści.
ANYONE_WITH_LINKEnumDostęp ma każda osoba mająca link.
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
AccessAccessTyp enum reprezentujący klasy użytkowników, którzy mogą uzyskać dostęp do pliku lub folderu, oprócz poszczególnych użytkowników, którzy uzyskali dostęp.
PermissionPermissionTyp enumeracji reprezentujący uprawnienia przyznane użytkownikom, którzy mogą uzyskać dostęp do pliku lub folderu, z wyłączeniem poszczególnych użytkowników, którym przyznano dostęp.

Metody

MetodaZwracany typKrótki opis
continueFileIterator(continuationToken)FileIteratorWznowienie iteracji pliku za pomocą tokena kontynuacji z poprzedniego iteratora.
continueFolderIterator(continuationToken)FolderIteratorWznawia iterację folderu za pomocą tokena kontynuacji z poprzedniego iteratora.
createFile(blob)FileTworzy plik w katalogu głównym Dysku użytkownika na podstawie dowolnych danych z danego Blob.
createFile(name, content)FileTworzy plik tekstowy w folderze głównym Dysku użytkownika o określonej nazwie i zawartości.
createFile(name, content, mimeType)FileTworzy plik w katalogu głównym Dysku użytkownika z podaną nazwą, treścią i typem MIME.
createFolder(name)FolderTworzy folder w katalogu głównym Dysku użytkownika o podanej nazwie.
createShortcut(targetId)FileTworzy skrót do podanego identyfikatora elementu na Dysku i zwraca go.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTworzy i zwraca skrót do podanego identyfikatora elementu i klucza zasobu na Dysku.
enforceSingleParent(value)voidWłącza lub wyłącza zachowanie enforceSingleParent dla 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ą daną 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 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 znajdujących się w koszu na Dysku użytkownika.
getTrashedFolders()FolderIteratorPobiera kolekcję wszystkich folderów znajdujących się 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 pasują do podanych kryteriów 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 podany tablicowy zbiór użytkowników do listy komentujących w ramach File.
addEditor(emailAddress)FileDodaje danego użytkownika do listy edytujących File.
addEditor(user)FileDodaje danego użytkownika do listy edytujących File.
addEditors(emailAddresses)FileDodaje podany tablicowy zbiór użytkowników do listy edytujących w przypadku File.
addViewer(emailAddress)FileDodaje danego użytkownika do listy widzów File.
addViewer(user)FileDodaje danego użytkownika do listy widzów File.
addViewers(emailAddresses)FileDodaje podany tablicowy zbiór 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 z tego obiektu jako blob przekonwertowany na określony typ treści.
getBlob()BlobZwraca dane z tego obiektu jako blob.
getDateCreated()DatePobiera 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 tego File.
getId()StringPobiera identyfikator File.
getLastUpdated()DatePobiera datę ostatniej aktualizacji elementu 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 folderami nadrzędnymi folderu 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 File może zastosować aktualizację zabezpieczeń, która wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniana za pomocą linku.
getSecurityUpdateEnabled()BooleanPobiera informację, czy ten File wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępniany za pomocą linku.
getSharingAccess()AccessPobiera informacje o klasie użytkowników, którzy mogą uzyskać dostęp do File, z wyjątkiem użytkowników, którzy mają wyraźnie przyznany dostęp.
getSharingPermission()PermissionPobiera uprawnienia przyznane użytkownikom, którzy mogą uzyskać dostęp do File, z wyjątkiem pojedynczych użytkowników, którym dostęp został wyraźnie przyznany.
getSize()IntegerPobiera liczbę bajtów użytych do przechowywania File na Dysku.
getTargetId()StringJeśli jest to skrót, zwraca identyfikator elementu, do którego się odwołuje.
getTargetMimeType()StringJeśli jest to skrót, zwraca typ MIME elementu, do którego się odwołuje.
getTargetResourceKey()StringJeśli plik jest skrótem, zwraca klucz zasobu elementu, do którego się odwołuje.
getThumbnail()BlobPobiera miniaturę pliku lub null, jeśli miniatura nie istnieje.
getUrl()StringPobiera adres URL, za pomocą którego można otworzyć File w aplikacji Google, takiej jak Dysk lub Dokumenty.
getViewers()User[]Pobiera listę osób, które oglądały lub komentowały ten File.
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji w File mogą udostępniać inne uprawnienia innym użytkownikom lub zmieniać uprawnienia.
isStarred()BooleanOkreśla, czy File zostało oznaczone 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 podany w prośbie nazwę.
makeCopy(name, destination)FileTworzy kopię pliku w katalogu docelowym i nadaje mu podany w parametrze nazwę.
moveTo(destination)FilePrzenosi ten element do podanego folderu docelowego.
removeCommenter(emailAddress)FileUsuwa danego użytkownika z listy komentujących w przypadku File.
removeCommenter(user)FileUsuwa danego użytkownika z listy komentujących w przypadku File.
removeEditor(emailAddress)FileUsunięcie danego użytkownika z listy edytujących w przypadku File.
removeEditor(user)FileUsunięcie danego użytkownika z listy edytujących w przypadku File.
removeViewer(emailAddress)FileUsunięcie danego użytkownika z listy widzów i komentujących File.
removeViewer(user)FileUsunięcie danego użytkownika z listy widzów i komentujących File.
revokePermissions(emailAddress)FileUnieważnia przyznany danemu użytkownikowi dostęp do File.
revokePermissions(user)FileUnieważnia przyznany danemu użytkownikowi dostęp do File.
setContent(content)FileZastępuje zawartość pliku podanym tekstem.
setDescription(description)FileUstawia opis File.
setName(name)FileUstawia nazwę 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ępniany za pomocą linku.
setShareableByEditors(shareable)FileOkreśla, czy użytkownicy z uprawnieniami do edycji File mogą udostępniać innym użytkownikom lub zmieniać uprawnienia.
setSharing(accessType, permissionType)FileOkreśla, które grupy użytkowników mogą uzyskać dostęp do File i jakie uprawnienia zostaną im przyznane, oprócz użytkowników indywidualnych, którzy uzyskali dostęp.
setStarred(starred)FileOkreśla, czy File ma być oznaczone 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óry można wykorzystać do wznowienia tej iteracji w późniejszym czasie.
hasNext()BooleanOkreśla, czy wywołanie next() spowoduje zwrot produktu.
next()FilePobiera następny element z kolekcji plików lub folderów.

Folder

Metody

MetodaZwracany typKrótki opis
addEditor(emailAddress)FolderDodaje danego użytkownika do listy edytujących Folder.
addEditor(user)FolderDodaje danego użytkownika do listy edytujących Folder.
addEditors(emailAddresses)FolderDodaje podany tablicowy zbiór użytkowników do listy edytujących w przypadku Folder.
addViewer(emailAddress)FolderDodaje danego użytkownika do listy widzów Folder.
addViewer(user)FolderDodaje danego użytkownika do listy widzów Folder.
addViewers(emailAddresses)FolderDodaje podany tablicowy zbiór użytkowników do listy widzów Folder.
createFile(blob)FileTworzy plik w bieżącym folderze na podstawie dowolnych danych z podanego zbioru danych Blob.
createFile(name, content)FileTworzy plik tekstowy w bieżącym folderze o podanej nazwie i treści.
createFile(name, content, mimeType)FileTworzy plik w bieżącym folderze z podaną nazwą, treścią i typem MIME.
createFolder(name)FolderTworzy folder w bieżącym folderze o podanej nazwie.
createShortcut(targetId)FileTworzy skrót do podanego identyfikatora elementu na Dysku i zwraca go.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileTworzy i zwraca skrót do podanego identyfikatora elementu i klucza zasobu na Dysku.
getAccess(email)PermissionPobiera uprawnienia przyznane konkretnemu użytkownikowi.
getAccess(user)PermissionPobiera uprawnienia przyznane konkretnemu użytkownikowi.
getDateCreated()DatePobiera datę utworzenia elementu Folder.
getDescription()StringPobiera opis elementu Folder.
getEditors()User[]Pobiera listę edytorów tego Folder.
getFiles()FileIteratorPobiera kolekcję wszystkich plików, które są podrzędnymi 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, które są podrzędnymi bieżącego folderu i mają podany typ MIME.
getFolders()FolderIteratorPobiera kolekcję wszystkich folderów podrzędnych bieżącego folderu.
getFoldersByName(name)FolderIteratorPobiera kolekcję wszystkich folderów, które są podrzędne względem bieżącego folderu i mają podaną nazwę.
getId()StringPobiera identyfikator Folder.
getLastUpdated()DatePobiera datę ostatniej aktualizacji elementu Folder.
getName()StringPobiera nazwę Folder.
getOwner()UserPobiera właściciela tego Folder.
getParents()FolderIteratorPobiera kolekcję folderów, które są bezpośrednimi folderami nadrzędnymi folderu 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 Folder może zastosować aktualizację zabezpieczeń, która wymaga klucza zasobu do uzyskania dostępu, gdy jest udostępniana za pomocą linku.
getSecurityUpdateEnabled()BooleanPobiera informację, czy ten Folder wymaga klucza zasobu, aby uzyskać dostęp, gdy jest udostępniany za pomocą linku.
getSharingAccess()AccessPobiera informacje o tym, którzy użytkownicy mają dostęp do Folder, z wyjątkiem użytkowników, którzy mają dostęp indywidualny.
getSharingPermission()PermissionPobiera uprawnienia przyznane użytkownikom, którzy mogą uzyskać dostęp do Folder, z wyjątkiem pojedynczych użytkowników, którym dostęp został wyraźnie przyznany.
getSize()IntegerPobiera liczbę bajtów użytych do przechowywania Folder na Dysku.
getUrl()StringPobiera adres URL, za pomocą którego można otworzyć Folder w aplikacji Google, takiej jak Dysk lub Dokumenty.
getViewers()User[]Pobiera listę osób, które oglądały lub komentowały ten Folder.
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji Folder mogą udostępniać inne uprawnienia innym użytkownikom lub zmieniać uprawnienia.
isStarred()BooleanOkreśla, czy Folder zostało oznaczone 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)FolderUsunięcie danego użytkownika z listy edytujących w przypadku Folder.
removeEditor(user)FolderUsunięcie danego użytkownika z listy edytujących w przypadku Folder.
removeViewer(emailAddress)FolderUsunięcie danego użytkownika z listy widzów i komentujących Folder.
removeViewer(user)FolderUsunięcie danego użytkownika z listy widzów i komentujących Folder.
revokePermissions(emailAddress)FolderUnieważnia przyznany danemu użytkownikowi dostęp do Folder.
revokePermissions(user)FolderUnieważnia przyznany danemu użytkownikowi dostęp do Folder.
searchFiles(params)FileIteratorPobiera kolekcję wszystkich plików, które są podrzędne bieżącego folderu i pasują do podanych kryteriów wyszukiwania.
searchFolders(params)FolderIteratorPobiera kolekcję wszystkich folderów, które są podfolderami bieżącego folderu i pasują do podanych kryteriów wyszukiwania.
setDescription(description)FolderUstawia opis Folder.
setName(name)FolderUstawia nazwę 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ępniany za pomocą linku.
setShareableByEditors(shareable)FolderOkreśla, czy użytkownicy z uprawnieniami do edycji Folder mogą udostępniać innym użytkownikom lub zmieniać uprawnienia.
setSharing(accessType, permissionType)FolderOkreśla, które grupy użytkowników mogą uzyskać dostęp do Folder i jakie uprawnienia zostaną im przyznane, z wyłączeniem użytkowników indywidualnych, którzy uzyskali dostęp wprost.
setStarred(starred)FolderOkreśla, czy Folder ma być oznaczone 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óry można wykorzystać do wznowienia tej iteracji w późniejszym czasie.
hasNext()BooleanOkreśla, czy wywołanie next() spowoduje zwrot produktu.
next()FolderPobiera następny element z 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ć lub 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ć 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ć, usuwać i przenosić treści na dysku współdzielonym.
NONEEnumUżytkownik nie ma żadnych uprawnień do pliku ani folderu.

User

Metody

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