Drive Service

Dirigir

Com esse serviço, os scripts podem criar, encontrar e modificar arquivos e pastas no Google Drive.

Se o script usar um projeto padrão do Cloud em vez de um projeto padrão, você precisará ativar manualmente a API Drive. No projeto padrão do Cloud, ative a API Drive:

Ativar a API Drive

O exemplo de código a seguir mostra como registrar os nomes de cada arquivo na pasta Meu Drive do usuário:
// 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());
}

Aulas

NomeBreve descrição
AccessUm enum que representa classes de usuários que podem acessar um arquivo ou pasta, além de quaisquer usuários individuais que receberam acesso explícito.
DriveAppPermite que os scripts criem, localizem e modifiquem arquivos e pastas no Google Drive.
FileÉ um arquivo no Google Drive.
FileIteratorUm iterador que permite que os scripts iterem em uma coleção potencialmente grande de arquivos.
FolderUma pasta no Google Drive.
FolderIteratorUm objeto que permite que os scripts façam iterações em uma coleção potencialmente grande de pastas.
PermissionUm enum que representa as permissões concedidas a usuários que podem acessar um arquivo ou pasta, além de qualquer usuário individual que tenha recebido acesso explicitamente.
UserUm usuário associado a um arquivo no Google Drive.

Access

Propriedades

PropriedadeTipoDescrição
ANYONEEnumQualquer pessoa na Internet pode encontrar e acessar.
ANYONE_WITH_LINKEnumQualquer pessoa com o link pode acessar.
DOMAINEnumAs pessoas no seu domínio podem encontrar e acessar.
DOMAIN_WITH_LINKEnumAs pessoas no seu domínio que têm o link podem acessar.
PRIVATEEnumSomente pessoas com permissão explícita podem acessar.

DriveApp

Propriedades

PropriedadeTipoDescrição
AccessAccessUm enum que representa classes de usuários que podem acessar um arquivo ou pasta, além de quaisquer usuários individuais que receberam acesso explícito.
PermissionPermissionUm enum que representa as permissões concedidas a usuários que podem acessar um arquivo ou pasta, além de qualquer usuário individual que tenha recebido acesso explicitamente.

Métodos

MétodoTipo de retornoBreve descrição
continueFileIterator(continuationToken)FileIteratorRetoma uma iteração de arquivo usando um token de continuação de um iterador anterior.
continueFolderIterator(continuationToken)FolderIteratorRetoma uma iteração de pasta usando um token de continuação de um iterador anterior.
createFile(blob)FileCria um arquivo na raiz do Drive do usuário com base em um determinado Blob de dados arbitrários.
createFile(name, content)FileCria um arquivo de texto na raiz do Drive do usuário com o nome e o conteúdo fornecidos.
createFile(name, content, mimeType)FileCria um arquivo na raiz do Drive do usuário com o nome, o conteúdo e o tipo MIME especificados.
createFolder(name)FolderCria uma pasta na raiz do Drive do usuário com o nome informado.
createShortcut(targetId)FileCria e retorna um atalho para o código do item do Drive fornecido.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCria e retorna um atalho para o ID do item do Drive e a chave de recurso fornecidos.
enforceSingleParent(value)voidAtiva ou desativa o comportamento de aplicação de SingleParent para todas as chamadas que afetam os pais de itens.
getFileById(id)FileRecebe o arquivo com o ID fornecido.
getFileByIdAndResourceKey(id, resourceKey)FileRecebe o arquivo com o ID e a chave de recurso fornecidos.
getFiles()FileIteratorExtrai uma coleção de todos os arquivos no Google Drive do usuário.
getFilesByName(name)FileIteratorExtrai um conjunto de todos os arquivos no Google Drive do usuário com o nome indicado.
getFilesByType(mimeType)FileIteratorExtrai um conjunto de todos os arquivos no Drive do usuário que têm o tipo MIME especificado.
getFolderById(id)FolderExtrai a pasta com o ID fornecido.
getFolderByIdAndResourceKey(id, resourceKey)FolderRecebe a pasta com o ID e a chave de recurso fornecidos.
getFolders()FolderIteratorExtrai uma coleção de todas as pastas no Drive do usuário.
getFoldersByName(name)FolderIteratorExtrai uma coleção de todas as pastas no Drive do usuário com o nome indicado.
getRootFolder()FolderExtrai a pasta na raiz do Drive do usuário.
getStorageLimit()IntegerMostra o número de bytes que o usuário pode armazenar no Drive.
getStorageUsed()IntegerExtrai o número de bytes que o usuário está armazenando no Drive.
getTrashedFiles()FileIteratorExtrai uma coleção de todos os arquivos na lixeira do Drive do usuário.
getTrashedFolders()FolderIteratorExtrai uma coleção de todas as pastas na lixeira do Drive do usuário.
searchFiles(params)FileIteratorExtrai um conjunto de todos os arquivos no Drive do usuário que correspondem aos critérios de pesquisa fornecidos.
searchFolders(params)FolderIteratorExtrai um conjunto de todas as pastas no Drive do usuário que correspondem aos critérios de pesquisa fornecidos.

File

Métodos

MétodoTipo de retornoBreve descrição
addCommenter(emailAddress)FileAdiciona o usuário especificado à lista de comentaristas de File.
addCommenter(user)FileAdiciona o usuário especificado à lista de comentaristas de File.
addCommenters(emailAddresses)FileAdicione a matriz de usuários especificada à lista de comentaristas de File.
addEditor(emailAddress)FileAdiciona o usuário especificado à lista de editores do File.
addEditor(user)FileAdiciona o usuário especificado à lista de editores do File.
addEditors(emailAddresses)FileAdiciona a matriz de usuários especificada à lista de editores do File.
addViewer(emailAddress)FileAdiciona o usuário especificado à lista de leitores do File.
addViewer(user)FileAdiciona o usuário especificado à lista de leitores do File.
addViewers(emailAddresses)FileAdiciona a matriz de usuários especificada à lista de leitores para o File.
getAccess(email)PermissionRecebe a permissão concedida ao usuário em questão.
getAccess(user)PermissionRecebe a permissão concedida ao usuário em questão.
getAs(contentType)BlobRetorne os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getDateCreated()DateExtrai a data em que o File foi criado.
getDescription()StringRecebe a descrição do File.
getDownloadUrl()StringExtrai o URL que pode ser usado para fazer o download do arquivo.
getEditors()User[]Recebe a lista de editores deste File.
getId()StringRecebe o ID do File.
getLastUpdated()DateRecebe a data da última atualização do File.
getMimeType()StringRecebe o tipo MIME do arquivo.
getName()StringRecebe o nome do File.
getOwner()UserExtrai o proprietário do arquivo.
getParents()FolderIteratorRecebe uma coleção de pastas que são pais imediatos de File.
getResourceKey()StringRecebe a chave de recurso do File que é necessária para acessar itens que foram compartilhados usando um link.
getSecurityUpdateEligible()BooleanDescobre se este File está qualificado para aplicar a atualização de segurança que requer uma chave de recurso para acesso quando ele é compartilhado usando um link.
getSecurityUpdateEnabled()BooleanDescobre se este File requer uma chave de recurso para acesso quando ele é compartilhado usando um link.
getSharingAccess()AccessExtrai qual classe de usuários pode acessar o File, além de todos os usuários individuais que receberam acesso explicitamente.
getSharingPermission()PermissionRecebe a permissão concedida aos usuários que podem acessar o File, além de qualquer usuário individual que tenha recebido acesso explicitamente.
getSize()IntegerRecebe o número de bytes usados para armazenar o File no Drive.
getTargetId()StringSe for um atalho, retorna o código do item para o qual ele aponta.
getTargetMimeType()StringSe for um atalho, retorna o tipo MIME do item para o qual ele aponta.
getTargetResourceKey()StringSe o arquivo for um atalho, retorna a chave de recurso do item para o qual ele aponta.
getThumbnail()BlobRecebe uma imagem em miniatura para o arquivo ou null se não houver uma miniatura.
getUrl()StringRecebe o URL que pode ser usado para abrir o File em um Google app, como o Drive ou o Documentos.
getViewers()User[]Recebe a lista de leitores e comentadores deste File.
isShareableByEditors()BooleanDetermina se os usuários com permissões para edição no File podem compartilhar com outros usuários ou alterar as permissões.
isStarred()BooleanDetermina se o File foi marcado com estrela no Drive do usuário.
isTrashed()BooleanDetermina se o File está na lixeira do Drive do usuário.
makeCopy()FileCria uma cópia do arquivo.
makeCopy(destination)FileCria uma cópia do arquivo no diretório de destino.
makeCopy(name)FileCria uma cópia do arquivo e a nomeia com o nome fornecido.
makeCopy(name, destination)FileCria uma cópia do arquivo no diretório de destino e a nomeia com o nome fornecido.
moveTo(destination)FileMove o item para a pasta de destino fornecida.
removeCommenter(emailAddress)FileRemove o usuário especificado da lista de comentaristas do File.
removeCommenter(user)FileRemove o usuário especificado da lista de comentaristas do File.
removeEditor(emailAddress)FileRemove o usuário especificado da lista de editores do File.
removeEditor(user)FileRemove o usuário especificado da lista de editores do File.
removeViewer(emailAddress)FileRemove o usuário especificado da lista de leitores e comentadores do File.
removeViewer(user)FileRemove o usuário especificado da lista de leitores e comentadores do File.
revokePermissions(emailAddress)FileRevoga o acesso ao File concedido ao usuário especificado.
revokePermissions(user)FileRevoga o acesso ao File concedido ao usuário especificado.
setContent(content)FileSubstitui o conteúdo do arquivo por uma substituição.
setDescription(description)FileDefine a descrição do File.
setName(name)FileDefine o nome do File.
setOwner(emailAddress)FileMuda o proprietário de File.
setOwner(user)FileMuda o proprietário de File.
setSecurityUpdateEnabled(enabled)FileDefine se o File requer uma chave de recurso para acesso quando é compartilhado por um link.
setShareableByEditors(shareable)FileDefine se os usuários com permissões para edição no File têm permissão para compartilhar com outros usuários ou alterar as permissões.
setSharing(accessType, permissionType)FileDefine qual classe de usuários pode acessar o File e quais permissões eles recebem, além de usuários individuais que receberam acesso explicitamente.
setStarred(starred)FileDefine se o File está marcado com estrela no Drive do usuário.
setTrashed(trashed)FileDefine se o File está na lixeira do Drive do usuário.

FileIterator

Métodos

MétodoTipo de retornoBreve descrição
getContinuationToken()StringRecebe um token que pode ser usado para retomar essa iteração mais tarde.
hasNext()BooleanDetermina se chamar next() retornará um item.
next()FileAcessa o próximo item da coleção de arquivos ou pastas.

Folder

Métodos

MétodoTipo de retornoBreve descrição
addEditor(emailAddress)FolderAdiciona o usuário especificado à lista de editores do Folder.
addEditor(user)FolderAdiciona o usuário especificado à lista de editores do Folder.
addEditors(emailAddresses)FolderAdiciona a matriz de usuários especificada à lista de editores do Folder.
addViewer(emailAddress)FolderAdiciona o usuário especificado à lista de leitores do Folder.
addViewer(user)FolderAdiciona o usuário especificado à lista de leitores do Folder.
addViewers(emailAddresses)FolderAdiciona a matriz de usuários especificada à lista de leitores para o Folder.
createFile(blob)FileCria um arquivo na pasta atual com base em um determinado Blob de dados arbitrários.
createFile(name, content)FileCria um arquivo de texto na pasta atual com o nome e o conteúdo fornecidos.
createFile(name, content, mimeType)FileCria um arquivo na pasta atual com o nome, o conteúdo e o tipo MIME fornecidos.
createFolder(name)FolderCria uma pasta na pasta atual com o nome informado.
createShortcut(targetId)FileCria e retorna um atalho para o código do item do Drive fornecido.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)FileCria e retorna um atalho para o ID do item do Drive e a chave de recurso fornecidos.
getAccess(email)PermissionRecebe a permissão concedida ao usuário em questão.
getAccess(user)PermissionRecebe a permissão concedida ao usuário em questão.
getDateCreated()DateExtrai a data em que o Folder foi criado.
getDescription()StringRecebe a descrição do Folder.
getEditors()User[]Recebe a lista de editores deste Folder.
getFiles()FileIteratorExtrai uma coleção de todos os arquivos filhos da pasta atual.
getFilesByName(name)FileIteratorExtrai uma coleção de todos os arquivos filhos da pasta atual e que têm o nome indicado.
getFilesByType(mimeType)FileIteratorRecebe uma coleção de todos os arquivos filhos da pasta atual e que têm o tipo MIME especificado.
getFolders()FolderIteratorExtrai uma coleção de todas as pastas filhas da pasta atual.
getFoldersByName(name)FolderIteratorExtrai uma coleção de todas as pastas filhas da pasta atual e que têm o nome indicado.
getId()StringRecebe o ID do Folder.
getLastUpdated()DateRecebe a data da última atualização do Folder.
getName()StringRecebe o nome do Folder.
getOwner()UserRecebe o proprietário deste Folder.
getParents()FolderIteratorRecebe uma coleção de pastas que são pais imediatos de Folder.
getResourceKey()StringRecebe a chave de recurso do Folder que é necessária para acessar itens que foram compartilhados usando um link.
getSecurityUpdateEligible()BooleanDescobre se este Folder está qualificado para aplicar a atualização de segurança que requer uma chave de recurso para acesso quando ele é compartilhado usando um link.
getSecurityUpdateEnabled()BooleanDescobre se este Folder requer uma chave de recurso para acesso quando ele é compartilhado usando um link.
getSharingAccess()AccessExtrai qual classe de usuários pode acessar o Folder, além de todos os usuários individuais que receberam acesso explicitamente.
getSharingPermission()PermissionRecebe a permissão concedida aos usuários que podem acessar o Folder, além de qualquer usuário individual que tenha recebido acesso explicitamente.
getSize()IntegerRecebe o número de bytes usados para armazenar o Folder no Drive.
getUrl()StringRecebe o URL que pode ser usado para abrir o Folder em um Google app, como o Drive ou o Documentos.
getViewers()User[]Recebe a lista de leitores e comentadores deste Folder.
isShareableByEditors()BooleanDetermina se os usuários com permissões para edição no Folder podem compartilhar com outros usuários ou alterar as permissões.
isStarred()BooleanDetermina se o Folder foi marcado com estrela no Drive do usuário.
isTrashed()BooleanDetermina se o Folder está na lixeira do Drive do usuário.
moveTo(destination)FolderMove o item para a pasta de destino fornecida.
removeEditor(emailAddress)FolderRemove o usuário especificado da lista de editores do Folder.
removeEditor(user)FolderRemove o usuário especificado da lista de editores do Folder.
removeViewer(emailAddress)FolderRemove o usuário especificado da lista de leitores e comentadores do Folder.
removeViewer(user)FolderRemove o usuário especificado da lista de leitores e comentadores do Folder.
revokePermissions(emailAddress)FolderRevoga o acesso ao Folder concedido ao usuário especificado.
revokePermissions(user)FolderRevoga o acesso ao Folder concedido ao usuário especificado.
searchFiles(params)FileIteratorRecebe uma coleção de todos os arquivos filhos da pasta atual e correspondem aos critérios de pesquisa fornecidos.
searchFolders(params)FolderIteratorRecebe uma coleção de todas as pastas filhas da pasta atual e correspondem aos critérios de pesquisa fornecidos.
setDescription(description)FolderDefine a descrição do Folder.
setName(name)FolderDefine o nome do Folder.
setOwner(emailAddress)FolderMuda o proprietário de Folder.
setOwner(user)FolderMuda o proprietário de Folder.
setSecurityUpdateEnabled(enabled)FolderDefine se o Folder requer uma chave de recurso para acesso quando é compartilhado por um link.
setShareableByEditors(shareable)FolderDefine se os usuários com permissões para edição no Folder têm permissão para compartilhar com outros usuários ou alterar as permissões.
setSharing(accessType, permissionType)FolderDefine qual classe de usuários pode acessar o Folder e quais permissões eles recebem, além de usuários individuais que receberam acesso explicitamente.
setStarred(starred)FolderDefine se o Folder está marcado com estrela no Drive do usuário.
setTrashed(trashed)FolderDefine se o Folder está na lixeira do Drive do usuário.

FolderIterator

Métodos

MétodoTipo de retornoBreve descrição
getContinuationToken()StringRecebe um token que pode ser usado para retomar essa iteração mais tarde.
hasNext()BooleanDetermina se chamar next() retornará um item.
next()FolderAcessa o próximo item da coleção de arquivos ou pastas.

Permission

Propriedades

PropriedadeTipoDescrição
VIEWEnumOs usuários com permissão para acessar o arquivo ou a pasta só poderão ver ou copiar o item.
EDITEnumOs usuários com permissão para acessar o arquivo ou a pasta podem editá-lo.
COMMENTEnumOs usuários com permissão para acessar o arquivo ou a pasta só poderão ver, copiar ou comentar o item.
OWNEREnumO usuário é proprietário do arquivo ou da pasta.
ORGANIZEREnumUsuários que podem organizar arquivos e pastas em um drive compartilhado.
FILE_ORGANIZEREnumUsuários que podem editar, enviar para a lixeira e mover conteúdo em um drive compartilhado.
NONEEnumO usuário não tem permissões para o arquivo ou a pasta.

User

Métodos

MétodoTipo de retornoBreve descrição
getDomain()StringAcessa o nome de domínio associado à conta do usuário.
getEmail()StringExtrai o endereço de e-mail do usuário.
getName()StringExtrai o nome do usuário.
getPhotoUrl()StringExtrai o URL da foto do usuário.