Drive Service

Dysk,

Ta usługa pozwala skryptom tworzyć, znajdować i modyfikować pliki oraz foldery na Dysku Google.

Jeśli Twój 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łączanie interfejsu Drive API

Poniższy przykładowy kod pokazuje, jak zapisać 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 wskazuje klasy użytkowników, którzy mają dostęp do pliku lub folderu, oraz pojedynczych użytkowników, którym przyznano dostęp wprost.
DriveAppUmożliwia skryptom tworzenie, znajdowanie i modyfikowanie plików i folderów na Dysku Google.
FilePlik na Dysku Google.
FileIteratoriterator, który pozwala skryptom na wykonywanie iteracji na potencjalnie duży zbiór plików.
FolderFolder na Dysku Google.
FolderIteratorObiekt umożliwiający iterację skryptu na potencjalnie duży zbiór folderów.
PermissionWyliczenie symbolizujące uprawnienia użytkownikom, którzy mają dostęp do pliku lub folderu, oraz innym użytkownikom, którym jednoznacznie przyznano dostęp.
UserUżytkownik powiązany z plikiem na Dysku Google.

Access

Właściwości

UsługaTypOpis
ANYONEEnumKażdy użytkownik internetu może znajdować te pliki i uzyskiwać do nich dostęp.
ANYONE_WITH_LINKEnumKażda osoba mająca link może uzyskiwać 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

UsługaTypOpis
AccessAccessWyliczenie wskazuje klasy użytkowników, którzy mają dostęp do pliku lub folderu, oraz pojedynczych użytkowników, którym przyznano dostęp wprost.
PermissionPermissionWyliczenie symbolizujące uprawnienia użytkownikom, którzy mają dostęp do pliku lub folderu, oraz innym użytkownikom, którym jednoznacznie przyznano dostęp.

Metody

MetodaZwracany typKrótki opis
continueFileIterator(continuationToken)FileIteratorWznowienie iteracji pliku przy użyciu tokena kontynuacji z poprzedniego iteratora.
continueFolderIterator(continuationToken)FolderIteratorWznowienie iteracji folderu przy użyciu tokena kontynuacji z poprzedniego iteratora.
createFile(blob)FileTworzy plik w katalogu głównym Dysku użytkownika na podstawie określonych Blob dowolnych danych.
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, treści i typie MIME.
createFolder(name)FolderPowoduje utworzenie folderu głównego 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 elementu elementu na Dysku i klucza zasobu, a następnie go zwraca.
enforceSingleParent(value)voidWłącza lub wyłącza egzekwowanie funkcji SingleSingle dla wszystkich wywołań dotyczących elementów nadrzędnych elementu.
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, które mają określoną nazwę.
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 kolekcję wszystkich folderów na Dysku użytkownika.
getFoldersByName(name)FolderIteratorPobiera kolekcję wszystkich folderów na Dysku użytkownika o określonej nazwie.
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 przechowywanych przez użytkownika na Dysku.
getTrashedFiles()FileIteratorPobiera zbiór wszystkich plików znajdujących się w koszu na Dysku użytkownika.
getTrashedFolders()FolderIteratorPobiera kolekcję wszystkich folderów w koszu 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 daną tablicę użytkowników do listy komentujących element File.
addEditor(emailAddress)FileDodaje danego użytkownika do listy edytorów elementu File.
addEditor(user)FileDodaje danego użytkownika do listy edytorów elementu File.
addEditors(emailAddresses)FileDodaje podaną tablicę użytkowników do listy edytorów obiektu File.
addViewer(emailAddress)FileDodaje danego użytkownika do listy gogli File.
addViewer(user)FileDodaje danego użytkownika do listy gogli File.
addViewers(emailAddresses)FileDodaje podaną tablicę użytkowników do listy widzów obiektu 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 w postaci obiektu blob przekonwertowanego na określony typ treści.
getBlob()BlobZwraca dane wewnątrz tego obiektu jako obiekt blob.
getDateCreated()DatePobiera datę utworzenia zasobu 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 na koncie 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 elementami nadrzędnym folderu File.
getResourceKey()StringPobiera klucz zasobu File, który jest wymagany do uzyskania dostępu do elementów udostępnionych przy użyciu linku.
getSecurityUpdateEligible()BooleanOkreśla, czy File może stosować aktualizację zabezpieczeń, która wymaga dostępu do zasobu za pomocą linku.
getSecurityUpdateEnabled()BooleanOkreśla, czy to File wymaga dostępu do zasobu za pomocą linku.
getSharingAccess()AccessOkreśla, do jakiej klasy użytkowników oprócz File mają mieć dostęp inni użytkownicy.
getSharingPermission()PermissionPobiera uprawnienia przyznawane użytkownikom, którzy mają dostęp do File, oraz wszystkie osoby, którym jednoznacznie przyznano dostęp.
getSize()IntegerPobiera liczbę bajtów przechowywanych na Dysku: File.
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 wskazanego elementu.
getThumbnail()BlobPobiera miniaturę pliku lub null, jeśli nie ma miniatury.
getUrl()StringPobiera adres URL, którego można użyć do otwarcia elementu File w aplikacji Google, takiej jak Dysk czy Dokumenty.
getViewers()User[]Pobiera listę widzów i komentujących ten element (File).
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji elementu File mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia.
isStarred()BooleanOkreśla, czy plik File został oznaczony na Dysku użytkownika.
isTrashed()BooleanOkreśla, czy plik File znajduje się w koszu na Dysku użytkownika.
makeCopy()FileTworzy kopię pliku.
makeCopy(destination)FileTworzy kopię pliku z katalogu docelowego.
makeCopy(name)FileTworzy kopię pliku i nadaje mu nazwę.
makeCopy(name, destination)FileTworzy kopię pliku w katalogu docelowym i nadaje mu nazwę.
moveTo(destination)FilePrzenosi ten element do podanego folderu docelowego.
removeCommenter(emailAddress)FileUsunięcie użytkownika z listy komentujących: File.
removeCommenter(user)FileUsunięcie użytkownika z listy komentujących: File.
removeEditor(emailAddress)FileUsunięcie tego użytkownika z listy edytorów File.
removeEditor(user)FileUsunięcie tego użytkownika z listy edytorów File.
removeViewer(emailAddress)FileUsunięcie użytkownika z listy widzów i komentujących w przypadku File.
removeViewer(user)FileUsunięcie użytkownika z listy widzów i komentujących w przypadku File.
revokePermissions(emailAddress)FileCofnie dostęp do File przyznany danemu użytkownikowi.
revokePermissions(user)FileCofnie dostęp do File przyznany danemu użytkownikowi.
setContent(content)FileZastępuje zawartość pliku danym elementem.
setDescription(description)FileUstawia opis elementu File.
setName(name)FileUstawia nazwę elementu 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 dostępu do zasobu, 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 klasy użytkowników, którzy mają mieć dostęp do File, i uprawnienia przyznawane tym użytkownikom oprócz poszczególnych użytkowników, którzy otrzymali bezpośrednie zezwolenie.
setStarred(starred)FileOkreśla, czy plik File jest oznaczony gwiazdką na Dysku użytkownika.
setTrashed(trashed)FileOkreśla, czy plik File znajduje się w koszu na Dysku użytkownika.

FileIterator

Metody

MetodaZwracany typKrótki opis
getContinuationToken()StringPobiera token, który można później użyć do wznowienia tego wystąpienia.
hasNext()BooleanOkreśla, czy wywołanie metody next() spowoduje zwrócenie elementu.
next()FilePobiera następny element ze zbioru plików lub folderów.

Folder

Metody

MetodaZwracany typKrótki opis
addEditor(emailAddress)FolderDodaje danego użytkownika do listy edytorów elementu Folder.
addEditor(user)FolderDodaje danego użytkownika do listy edytorów elementu Folder.
addEditors(emailAddresses)FolderDodaje podaną tablicę użytkowników do listy edytorów obiektu Folder.
addViewer(emailAddress)FolderDodaje danego użytkownika do listy gogli Folder.
addViewer(user)FolderDodaje danego użytkownika do listy gogli Folder.
addViewers(emailAddresses)FolderDodaje podaną tablicę użytkowników do listy widzów obiektu Folder.
createFile(blob)FileTworzy plik w bieżącym folderze na podstawie danych Blob dowolnych danych.
createFile(name, content)FileTworzy w bieżącym folderze plik tekstowy o podanej nazwie i podanej zawartości.
createFile(name, content, mimeType)FileTworzy w bieżącym folderze plik o podanej nazwie, zawartości i typie 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 skrót do podanego elementu 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 zasobu Folder.
getDescription()StringPobiera opis elementu Folder.
getEditors()User[]Pobiera listę edytorów na koncie Folder.
getFiles()FileIteratorPobiera zbiór wszystkich plików podrzędnych bieżącego folderu.
getFilesByName(name)FileIteratorPobiera kolekcję wszystkich plików podrzędnych bieżącego folderu o podanej nazwie.
getFilesByType(mimeType)FileIteratorPobiera zbiór wszystkich plików, które są elementami podrzędnymi bieżącego folderu i mają dany typ MIME.
getFolders()FolderIteratorPobiera kolekcję wszystkich folderów podrzędnych bieżącego folderu.
getFoldersByName(name)FolderIteratorPobiera kolekcję wszystkich folderów podrzędnych folderu bieżącego o podanej nazwie.
getId()StringPobiera identyfikator Folder.
getLastUpdated()DatePobiera datę ostatniej aktualizacji elementu Folder.
getName()StringPobiera nazwę Folder.
getOwner()UserPobiera właściciela tego elementu (Folder).
getParents()FolderIteratorPobiera kolekcję folderów, które są bezpośrednimi elementami nadrzędnym folderu Folder.
getResourceKey()StringPobiera klucz zasobu Folder, który jest wymagany do uzyskania dostępu do elementów udostępnionych przy użyciu linku.
getSecurityUpdateEligible()BooleanOkreśla, czy Folder może stosować aktualizację zabezpieczeń, która wymaga dostępu do zasobu za pomocą linku.
getSecurityUpdateEnabled()BooleanOkreśla, czy to Folder wymaga dostępu do zasobu za pomocą linku.
getSharingAccess()AccessOkreśla, do jakiej klasy użytkowników oprócz Folder mają mieć dostęp inni użytkownicy.
getSharingPermission()PermissionPobiera uprawnienia przyznawane użytkownikom, którzy mają dostęp do Folder, oraz wszystkie osoby, którym jednoznacznie przyznano dostęp.
getSize()IntegerPobiera liczbę bajtów przechowywanych na Dysku: Folder.
getUrl()StringPobiera adres URL, którego można użyć do otwarcia elementu Folder w aplikacji Google, takiej jak Dysk czy Dokumenty.
getViewers()User[]Pobiera listę widzów i komentujących ten element (Folder).
isShareableByEditors()BooleanOkreśla, czy użytkownicy z uprawnieniami do edycji elementu Folder mogą udostępniać pliki innym użytkownikom lub zmieniać uprawnienia.
isStarred()BooleanOkreśla, czy plik Folder został oznaczony na Dysku użytkownika.
isTrashed()BooleanOkreśla, czy plik Folder znajduje się w koszu na Dysku użytkownika.
moveTo(destination)FolderPrzenosi ten element do podanego folderu docelowego.
removeEditor(emailAddress)FolderUsunięcie tego użytkownika z listy edytorów Folder.
removeEditor(user)FolderUsunięcie tego użytkownika z listy edytorów Folder.
removeViewer(emailAddress)FolderUsunięcie użytkownika z listy widzów i komentujących w przypadku Folder.
removeViewer(user)FolderUsunięcie użytkownika z listy widzów i komentujących w przypadku Folder.
revokePermissions(emailAddress)FolderCofnie dostęp do Folder przyznany danemu użytkownikowi.
revokePermissions(user)FolderCofnie dostęp do Folder przyznany danemu użytkownikowi.
searchFiles(params)FileIteratorPobiera zbiór wszystkich plików podrzędnych bieżącego folderu, które pasują do podanych kryteriów wyszukiwania.
searchFolders(params)FolderIteratorPobiera zbiór wszystkich folderów podrzędnych bieżącego folderu, które pasują do podanych kryteriów wyszukiwania.
setDescription(description)FolderUstawia opis elementu Folder.
setName(name)FolderUstawia nazwę elementu 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 dostępu do zasobu, 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 klasy użytkowników, którzy mają mieć dostęp do Folder, i uprawnienia przyznawane tym użytkownikom oprócz poszczególnych użytkowników, którzy otrzymali bezpośrednie zezwolenie.
setStarred(starred)FolderOkreśla, czy plik Folder jest oznaczony gwiazdką na Dysku użytkownika.
setTrashed(trashed)FolderOkreśla, czy plik Folder znajduje się w koszu na Dysku użytkownika.

FolderIterator

Metody

MetodaZwracany typKrótki opis
getContinuationToken()StringPobiera token, który można później użyć do wznowienia tego wystąpienia.
hasNext()BooleanOkreśla, czy wywołanie metody next() spowoduje zwrócenie elementu.
next()FolderPobiera następny element ze zbioru plików lub folderów.

Permission

Właściwości

UsługaTypOpis
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ą tylko go wyświetlać, kopiować i komentować.
OWNEREnumPlik lub folder jest własnością użytkownika.
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 tego 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.