Drive Service

Drive

Questo servizio consente agli script di creare, trovare e modificare file e cartelle su Google Drive.

Se lo script utilizza un progetto Cloud standard instead of a default Cloud project, devi attivare manualmente l'API Drive. Nel progetto Cloud standard, attiva l'API Drive:

Attiva l'API Drive

Il seguente snippet di codice mostra come registrare i nomi di ogni file nella cartella Il mio Drive dell'utente:
// 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());
}

Corsi

NomeBreve descrizione
AccessUn enum che rappresenta le classi di utenti che possono accedere a un file o a una cartella, oltre a eventuali singoli utenti a cui è stato concesso l'accesso esplicitamente.
DriveAppConsente agli script di creare, trovare e modificare file e cartelle su Google Drive.
FileUn file su Google Drive.
FileIteratorUn iteratore che consente agli script di eseguire l'iterazione su una raccolta potenzialmente grande di file.
FolderUna cartella in Google Drive.
FolderIteratorUn oggetto che consente agli script di eseguire l'iterazione su una raccolta potenzialmente grande di cartelle.
PermissionUn enum che rappresenta le autorizzazioni concesse agli utenti che possono accedere a un file o a una cartella, oltre a eventuali singoli utenti a cui è stato concesso l'accesso in modo esplicito.
UserUn utente associato a un file in Google Drive.

Access

Proprietà

ProprietàTipoDescrizione
ANYONEEnumChiunque navighi su internet può trovare e accedere a questo elemento.
ANYONE_WITH_LINKEnumChiunque abbia il link può accedere.
DOMAINEnumLe persone nel tuo dominio possono trovare e accedere.
DOMAIN_WITH_LINKEnumGli utenti del tuo dominio che hanno il link possono accedere.
PRIVATEEnumL'accesso è riservato a utenti che hanno esplicitamente ricevuto un'autorizzazione.

DriveApp

Proprietà

ProprietàTipoDescrizione
AccessAccessUn enum che rappresenta le classi di utenti che possono accedere a un file o a una cartella, oltre a eventuali singoli utenti a cui è stato concesso l'accesso esplicitamente.
PermissionPermissionUn enum che rappresenta le autorizzazioni concesse agli utenti che possono accedere a un file o a una cartella, oltre a eventuali singoli utenti a cui è stato concesso l'accesso in modo esplicito.

Metodi

MetodoTipo restituitoBreve descrizione
continueFileIterator(continuationToken)FileIteratorRiprende un'iterazione del file utilizzando un token di continuazione di un iteratore precedente.
continueFolderIterator(continuationToken)FolderIteratorRiprende un'iterazione della cartella utilizzando un token di continuazione di un iteratore precedente.
createFile(blob)FileCrea un file nella directory principale di Drive dell'utente da un determinato Blob di dati arbitrari.
createFile(name, content)FileCrea un file di testo nella cartella principale del Drive dell'utente con il nome e i contenuti specificati.
createFile(name, content, mimeType)FileCrea un file nella directory principale del Drive dell'utente con il nome, i contenuti e il tipo MIME specificati.
createFolder(name)FolderCrea una cartella nella cartella principale di Drive dell'utente con il nome specificato.
createShortcut(targetId)FileCrea una scorciatoia all'ID elemento di Drive fornito e la restituisce.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrea una scorciatoia all'ID elemento e alla chiave della risorsa di Drive forniti e la restituisce.
enforceSingleParent(value)voidAttiva o disattiva il comportamento enforceSingleParent per tutte le chiamate che interessano gli elementi principali.
getFileById(id)FileRecupera il file con l'ID specificato.
getFileByIdAndResourceKey(id, resourceKey)FileRecupera il file con l'ID e la chiave di risorsa specificati.
getFiles()FileIteratorRecupera una raccolta di tutti i file in Drive dell'utente.
getFilesByName(name)FileIteratorRecupera una raccolta di tutti i file nel Drive dell'utente che hanno il nome specificato.
getFilesByType(mimeType)FileIteratorRecupera una raccolta di tutti i file nel Drive dell'utente che hanno il tipo MIME specificato.
getFolderById(id)FolderRecupera la cartella con l'ID specificato.
getFolderByIdAndResourceKey(id, resourceKey)FolderRecupera la cartella con l'ID e la chiave della risorsa specificati.
getFolders()FolderIteratorRecupera una raccolta di tutte le cartelle in Drive dell'utente.
getFoldersByName(name)FolderIteratorRestituisce una raccolta di tutte le cartelle di Drive dell'utente che hanno il nome specificato.
getRootFolder()FolderRecupera la cartella principale di Drive dell'utente.
getStorageLimit()IntegerRestituisce il numero di byte che l'utente è autorizzato a memorizzare su Drive.
getStorageUsed()IntegerRecupera il numero di byte attualmente archiviati dall'utente su Drive.
getTrashedFiles()FileIteratorRecupera una raccolta di tutti i file nel cestino di Drive dell'utente.
getTrashedFolders()FolderIteratorRecupera una raccolta di tutte le cartelle presenti nel cestino di Drive dell'utente.
searchFiles(params)FileIteratorRecupera una raccolta di tutti i file su Drive dell'utente che corrispondono ai criteri di ricerca specificati.
searchFolders(params)FolderIteratorRecupera una raccolta di tutte le cartelle di Drive dell'utente che corrispondono ai criteri di ricerca specificati.

File

Metodi

MetodoTipo restituitoBreve descrizione
addCommenter(emailAddress)FileAggiungi l'utente specificato all'elenco dei commentatori per File.
addCommenter(user)FileAggiungi l'utente specificato all'elenco dei commentatori per File.
addCommenters(emailAddresses)FileAggiungi l'array di utenti specificato all'elenco dei commentatori per File.
addEditor(emailAddress)FileAggiunge l'utente specificato all'elenco degli editor di File.
addEditor(user)FileAggiunge l'utente specificato all'elenco degli editor di File.
addEditors(emailAddresses)FileAggiunge l'array di utenti specificato all'elenco degli editor di File.
addViewer(emailAddress)FileAggiunge l'utente specificato all'elenco degli spettatori del File.
addViewer(user)FileAggiunge l'utente specificato all'elenco degli spettatori del File.
addViewers(emailAddresses)FileAggiunge l'array di utenti specificato all'elenco degli spettatori per File.
getAccess(email)PermissionRecupera l'autorizzazione concessa a un utente specifico.
getAccess(user)PermissionRecupera l'autorizzazione concessa a un utente specifico.
getAs(contentType)BlobRestituisce i dati all'interno di questo oggetto come blob convertito nel tipo di contenuti specificato.
getBlob()BlobRestituisce i dati all'interno di questo oggetto come blob.
getDateCreated()DateRecupera la data di creazione del File.
getDescription()StringRecupera la descrizione di File.
getDownloadUrl()StringRecupera l'URL che può essere utilizzato per scaricare il file.
getEditors()User[]Recupera l'elenco degli editor di questo File.
getId()StringRecupera l'ID del File.
getLastUpdated()DateRecupera la data dell'ultimo aggiornamento di File.
getMimeType()StringRecupera il tipo MIME del file.
getName()StringRecupera il nome del File.
getOwner()UserRecupera il proprietario del file.
getParents()FolderIteratorRecupera una raccolta di cartelle che sono le cartelle principali immediate di File.
getResourceKey()StringRecupera la chiave della risorsa del File necessaria per accedere agli elementi che sono stati condivisi utilizzando un link.
getSecurityUpdateEligible()BooleanIndica se questo File è idoneo per l'applicazione dell'aggiornamento della sicurezza che richiede una chiave di accesso alla risorsa quando viene condiviso tramite un link.
getSecurityUpdateEnabled()BooleanIndica se questo File richiede una chiave della risorsa per l'accesso quando viene condiviso utilizzando un link.
getSharingAccess()AccessRestituisce la classe di utenti che può accedere al File, oltre ai singoli utenti a cui è stato concesso l'accesso esplicitamente.
getSharingPermission()PermissionRecupera l'autorizzazione concessa agli utenti che possono accedere a File, oltre ai singoli utenti a cui è stato concesso l'accesso esplicitamente.
getSize()IntegerRecupera il numero di byte utilizzati per archiviare il file File su Drive.
getTargetId()StringSe si tratta di una scorciatoia, restituisce l'ID dell'elemento a cui rimanda.
getTargetMimeType()StringSe si tratta di una scorciatoia, restituisce il tipo MIME dell'elemento a cui rimanda.
getTargetResourceKey()StringSe il file è una scorciatoia, restituisce la chiave della risorsa dell'elemento a cui rimanda.
getThumbnail()BlobRestituisce un'immagine in miniatura del file o null se non esiste alcuna miniatura.
getUrl()StringRecupera l'URL che può essere utilizzato per aprire il File in un'app Google come Drive o Documenti.
getViewers()User[]Recupera l'elenco di visualizzatori e commentatori per questo File.
isShareableByEditors()BooleanDetermina se gli utenti con autorizzazioni di modifica per il File possono condividerlo con altri utenti o modificarne le autorizzazioni.
isStarred()BooleanDetermina se File è stato aggiunto ai preferiti su Drive dell'utente.
isTrashed()BooleanDetermina se File si trova nel cestino di Drive dell'utente.
makeCopy()FileCrea una copia del file.
makeCopy(destination)FileCrea una copia del file nella directory di destinazione.
makeCopy(name)FileCrea una copia del file e la rinomina con il nome fornito.
makeCopy(name, destination)FileCrea una copia del file nella directory di destinazione e la rinomina con il nome fornito.
moveTo(destination)FileSposta questo elemento nella cartella di destinazione specificata.
removeCommenter(emailAddress)FileRimuove l'utente specificato dall'elenco dei commentatori per il File.
removeCommenter(user)FileRimuove l'utente specificato dall'elenco dei commentatori per il File.
removeEditor(emailAddress)FileRimuove l'utente specificato dall'elenco degli editor di File.
removeEditor(user)FileRimuove l'utente specificato dall'elenco degli editor di File.
removeViewer(emailAddress)FileRimuove l'utente specificato dall'elenco di visualizzatori e commentatori per il File.
removeViewer(user)FileRimuove l'utente specificato dall'elenco di visualizzatori e commentatori per il File.
revokePermissions(emailAddress)FileRevoca l'accesso a File concesso all'utente specificato.
revokePermissions(user)FileRevoca l'accesso a File concesso all'utente specificato.
setContent(content)FileSostituisce i contenuti del file con una determinata sostituzione.
setDescription(description)FileImposta la descrizione per File.
setName(name)FileImposta il nome del File.
setOwner(emailAddress)FileModifica il proprietario del File.
setOwner(user)FileModifica il proprietario del File.
setSecurityUpdateEnabled(enabled)FileImposta se File richiede una chiave della risorsa per l'accesso quando viene condivisa utilizzando un link.
setShareableByEditors(shareable)FileImposta se gli utenti con autorizzazioni di modifica per il File possono condividerlo con altri utenti o modificarne le autorizzazioni.
setSharing(accessType, permissionType)FileImposta la classe di utenti che può accedere a File e le autorizzazioni concesse a questi utenti, oltre ai singoli utenti a cui è stato concesso l'accesso esplicitamente.
setStarred(starred)FileImposta se File è contrassegnato come preferito in Drive dell'utente.
setTrashed(trashed)FileImposta se File si trova nel cestino di Drive dell'utente.

FileIterator

Metodi

MetodoTipo restituitoBreve descrizione
getContinuationToken()StringRestituisce un token che può essere utilizzato per riprendere questa iterazione in un secondo momento.
hasNext()BooleanDetermina se la chiamata a next() restituirà un elemento.
next()FileRecupera l'elemento successivo nella raccolta di file o cartelle.

Folder

Metodi

MetodoTipo restituitoBreve descrizione
addEditor(emailAddress)FolderAggiunge l'utente specificato all'elenco degli editor di Folder.
addEditor(user)FolderAggiunge l'utente specificato all'elenco degli editor di Folder.
addEditors(emailAddresses)FolderAggiunge l'array di utenti specificato all'elenco degli editor di Folder.
addViewer(emailAddress)FolderAggiunge l'utente specificato all'elenco degli spettatori del Folder.
addViewer(user)FolderAggiunge l'utente specificato all'elenco degli spettatori del Folder.
addViewers(emailAddresses)FolderAggiunge l'array di utenti specificato all'elenco degli spettatori per Folder.
createFile(blob)FileCrea un file nella cartella corrente da un determinato Blob di dati arbitrari.
createFile(name, content)FileCrea un file di testo nella cartella corrente con il nome e i contenuti specificati.
createFile(name, content, mimeType)FileCrea un file nella cartella corrente con il nome, i contenuti e il tipo MIME specificati.
createFolder(name)FolderCrea una cartella nella cartella corrente con il nome specificato.
createShortcut(targetId)FileCrea e restituisce una scorciatoia all'ID elemento di Drive fornito.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCrea una scorciatoia all'ID elemento e alla chiave della risorsa di Drive forniti e la restituisce.
getAccess(email)PermissionRecupera l'autorizzazione concessa a un utente specifico.
getAccess(user)PermissionRecupera l'autorizzazione concessa a un utente specifico.
getDateCreated()DateRecupera la data di creazione del Folder.
getDescription()StringRecupera la descrizione di Folder.
getEditors()User[]Recupera l'elenco degli editor di questo Folder.
getFiles()FileIteratorRecupera una raccolta di tutti i file che sono elementi secondari della cartella corrente.
getFilesByName(name)FileIteratorRecupera una raccolta di tutti i file secondari della cartella corrente che hanno il nome specificato.
getFilesByType(mimeType)FileIteratorRecupera una raccolta di tutti i file secondari della cartella corrente e con il tipo MIME specificato.
getFolders()FolderIteratorRecupera una raccolta di tutte le cartelle secondarie della cartella corrente.
getFoldersByName(name)FolderIteratorRecupera una raccolta di tutte le cartelle secondarie della cartella corrente che hanno il nome specificato.
getId()StringRecupera l'ID del Folder.
getLastUpdated()DateRecupera la data dell'ultimo aggiornamento di Folder.
getName()StringRecupera il nome del Folder.
getOwner()UserRestituisce il proprietario di questo Folder.
getParents()FolderIteratorRecupera una raccolta di cartelle che sono le cartelle principali immediate di Folder.
getResourceKey()StringRecupera la chiave della risorsa del Folder necessaria per accedere agli elementi che sono stati condivisi utilizzando un link.
getSecurityUpdateEligible()BooleanIndica se questo Folder è idoneo per l'applicazione dell'aggiornamento della sicurezza che richiede una chiave di accesso alla risorsa quando viene condiviso tramite un link.
getSecurityUpdateEnabled()BooleanIndica se questo Folder richiede una chiave della risorsa per l'accesso quando viene condiviso utilizzando un link.
getSharingAccess()AccessRestituisce la classe di utenti che può accedere al Folder, oltre ai singoli utenti a cui è stato concesso l'accesso esplicitamente.
getSharingPermission()PermissionRecupera l'autorizzazione concessa agli utenti che possono accedere a Folder, oltre ai singoli utenti a cui è stato concesso l'accesso esplicitamente.
getSize()IntegerRecupera il numero di byte utilizzati per archiviare il file Folder su Drive.
getUrl()StringRecupera l'URL che può essere utilizzato per aprire il Folder in un'app Google come Drive o Documenti.
getViewers()User[]Recupera l'elenco di visualizzatori e commentatori per questo Folder.
isShareableByEditors()BooleanDetermina se gli utenti con autorizzazioni di modifica per il Folder possono condividerlo con altri utenti o modificarne le autorizzazioni.
isStarred()BooleanDetermina se Folder è stato aggiunto ai preferiti su Drive dell'utente.
isTrashed()BooleanDetermina se Folder si trova nel cestino di Drive dell'utente.
moveTo(destination)FolderSposta questo elemento nella cartella di destinazione specificata.
removeEditor(emailAddress)FolderRimuove l'utente specificato dall'elenco degli editor di Folder.
removeEditor(user)FolderRimuove l'utente specificato dall'elenco degli editor di Folder.
removeViewer(emailAddress)FolderRimuove l'utente specificato dall'elenco di visualizzatori e commentatori per il Folder.
removeViewer(user)FolderRimuove l'utente specificato dall'elenco di visualizzatori e commentatori per il Folder.
revokePermissions(emailAddress)FolderRevoca l'accesso a Folder concesso all'utente specificato.
revokePermissions(user)FolderRevoca l'accesso a Folder concesso all'utente specificato.
searchFiles(params)FileIteratorRecupera una raccolta di tutti i file che sono figli della cartella corrente e corrispondono ai criteri di ricerca specificati.
searchFolders(params)FolderIteratorRecupera una raccolta di tutte le cartelle secondarie della cartella corrente che corrispondono ai criteri di ricerca specificati.
setDescription(description)FolderImposta la descrizione per Folder.
setName(name)FolderImposta il nome del Folder.
setOwner(emailAddress)FolderModifica il proprietario del Folder.
setOwner(user)FolderModifica il proprietario del Folder.
setSecurityUpdateEnabled(enabled)FolderImposta se Folder richiede una chiave della risorsa per l'accesso quando viene condivisa utilizzando un link.
setShareableByEditors(shareable)FolderImposta se gli utenti con autorizzazioni di modifica per il Folder possono condividerlo con altri utenti o modificarne le autorizzazioni.
setSharing(accessType, permissionType)FolderImposta la classe di utenti che può accedere a Folder e le autorizzazioni concesse a questi utenti, oltre ai singoli utenti a cui è stato concesso l'accesso esplicitamente.
setStarred(starred)FolderImposta se Folder è contrassegnato come preferito in Drive dell'utente.
setTrashed(trashed)FolderImposta se Folder si trova nel cestino di Drive dell'utente.

FolderIterator

Metodi

MetodoTipo restituitoBreve descrizione
getContinuationToken()StringRestituisce un token che può essere utilizzato per riprendere questa iterazione in un secondo momento.
hasNext()BooleanDetermina se la chiamata a next() restituirà un elemento.
next()FolderRecupera l'elemento successivo nella raccolta di file o cartelle.

Permission

Proprietà

ProprietàTipoDescrizione
VIEWEnumGli utenti che possono accedere al file o alla cartella possono solo visualizzarlo o copiarlo.
EDITEnumGli utenti che possono accedere al file o alla cartella possono modificarli.
COMMENTEnumGli utenti che possono accedere al file o alla cartella possono solo visualizzarli, copiarli o commentarli.
OWNEREnumL'utente è il proprietario del file o della cartella.
ORGANIZEREnumUtenti che possono organizzare file e cartelle all'interno di un Drive condiviso.
FILE_ORGANIZEREnumUtenti che possono modificare, eliminare e spostare contenuti all'interno di un Drive condiviso.
NONEEnumL'utente non dispone di autorizzazioni per il file o la cartella.

User

Metodi

MetodoTipo restituitoBreve descrizione
getDomain()StringRecupera il nome di dominio associato all'account dell'utente.
getEmail()StringRecupera l'indirizzo email dell'utente.
getName()StringRecupera il nome dell'utente.
getPhotoUrl()StringRecupera l'URL della foto dell'utente.